http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.ThrowableAbortable.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.ThrowableAbortable.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.ThrowableAbortable.html index 8a265ce..b5aa71a 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.ThrowableAbortable.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.ThrowableAbortable.html @@ -6,7 +6,7 @@ </head> <body> <div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> <span class="sourceLineNo">002</span> *<a name="line.2"></a> <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.TruncateTableFuture.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.TruncateTableFuture.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.TruncateTableFuture.html index 8a265ce..b5aa71a 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.TruncateTableFuture.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.TruncateTableFuture.html @@ -6,7 +6,7 @@ </head> <body> <div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> <span class="sourceLineNo">002</span> *<a name="line.2"></a> <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.html index 8a265ce..b5aa71a 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/HBaseAdmin.html @@ -6,7 +6,7 @@ </head> <body> <div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> <span class="sourceLineNo">002</span> *<a name="line.2"></a> <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/BaseEnvironment.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/BaseEnvironment.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/BaseEnvironment.html index a22e927..c1dae31 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/BaseEnvironment.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/BaseEnvironment.html @@ -59,96 +59,95 @@ <span class="sourceLineNo">051</span> * @param impl the coprocessor instance<a name="line.51"></a> <span class="sourceLineNo">052</span> * @param priority chaining priority<a name="line.52"></a> <span class="sourceLineNo">053</span> */<a name="line.53"></a> -<span class="sourceLineNo">054</span> public BaseEnvironment(final C impl, final int priority,<a name="line.54"></a> -<span class="sourceLineNo">055</span> final int seq, final Configuration conf) {<a name="line.55"></a> -<span class="sourceLineNo">056</span> this.impl = impl;<a name="line.56"></a> -<span class="sourceLineNo">057</span> this.classLoader = impl.getClass().getClassLoader();<a name="line.57"></a> -<span class="sourceLineNo">058</span> this.priority = priority;<a name="line.58"></a> -<span class="sourceLineNo">059</span> this.state = Coprocessor.State.INSTALLED;<a name="line.59"></a> -<span class="sourceLineNo">060</span> this.seq = seq;<a name="line.60"></a> -<span class="sourceLineNo">061</span> this.conf = conf;<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> /** Initialize the environment */<a name="line.64"></a> -<span class="sourceLineNo">065</span> @Override<a name="line.65"></a> -<span class="sourceLineNo">066</span> public void startup() throws IOException {<a name="line.66"></a> -<span class="sourceLineNo">067</span> if (state == Coprocessor.State.INSTALLED ||<a name="line.67"></a> -<span class="sourceLineNo">068</span> state == Coprocessor.State.STOPPED) {<a name="line.68"></a> -<span class="sourceLineNo">069</span> state = Coprocessor.State.STARTING;<a name="line.69"></a> -<span class="sourceLineNo">070</span> Thread currentThread = Thread.currentThread();<a name="line.70"></a> -<span class="sourceLineNo">071</span> ClassLoader hostClassLoader = currentThread.getContextClassLoader();<a name="line.71"></a> -<span class="sourceLineNo">072</span> try {<a name="line.72"></a> -<span class="sourceLineNo">073</span> currentThread.setContextClassLoader(this.getClassLoader());<a name="line.73"></a> -<span class="sourceLineNo">074</span> impl.start(this);<a name="line.74"></a> -<span class="sourceLineNo">075</span> state = Coprocessor.State.ACTIVE;<a name="line.75"></a> -<span class="sourceLineNo">076</span> } finally {<a name="line.76"></a> -<span class="sourceLineNo">077</span> currentThread.setContextClassLoader(hostClassLoader);<a name="line.77"></a> -<span class="sourceLineNo">078</span> }<a name="line.78"></a> -<span class="sourceLineNo">079</span> } else {<a name="line.79"></a> -<span class="sourceLineNo">080</span> LOG.warn("Not starting coprocessor " + impl.getClass().getName() +<a name="line.80"></a> -<span class="sourceLineNo">081</span> " because not inactive (state=" + state.toString() + ")");<a name="line.81"></a> -<span class="sourceLineNo">082</span> }<a name="line.82"></a> -<span class="sourceLineNo">083</span> }<a name="line.83"></a> -<span class="sourceLineNo">084</span><a name="line.84"></a> -<span class="sourceLineNo">085</span> /** Clean up the environment */<a name="line.85"></a> -<span class="sourceLineNo">086</span> @Override<a name="line.86"></a> -<span class="sourceLineNo">087</span> public void shutdown() {<a name="line.87"></a> -<span class="sourceLineNo">088</span> if (state == Coprocessor.State.ACTIVE) {<a name="line.88"></a> -<span class="sourceLineNo">089</span> state = Coprocessor.State.STOPPING;<a name="line.89"></a> -<span class="sourceLineNo">090</span> Thread currentThread = Thread.currentThread();<a name="line.90"></a> -<span class="sourceLineNo">091</span> ClassLoader hostClassLoader = currentThread.getContextClassLoader();<a name="line.91"></a> -<span class="sourceLineNo">092</span> try {<a name="line.92"></a> -<span class="sourceLineNo">093</span> currentThread.setContextClassLoader(this.getClassLoader());<a name="line.93"></a> -<span class="sourceLineNo">094</span> impl.stop(this);<a name="line.94"></a> -<span class="sourceLineNo">095</span> state = Coprocessor.State.STOPPED;<a name="line.95"></a> -<span class="sourceLineNo">096</span> } catch (IOException ioe) {<a name="line.96"></a> -<span class="sourceLineNo">097</span> LOG.error("Error stopping coprocessor "+impl.getClass().getName(), ioe);<a name="line.97"></a> -<span class="sourceLineNo">098</span> } finally {<a name="line.98"></a> -<span class="sourceLineNo">099</span> currentThread.setContextClassLoader(hostClassLoader);<a name="line.99"></a> -<span class="sourceLineNo">100</span> }<a name="line.100"></a> -<span class="sourceLineNo">101</span> } else {<a name="line.101"></a> -<span class="sourceLineNo">102</span> LOG.warn("Not stopping coprocessor "+impl.getClass().getName()+<a name="line.102"></a> -<span class="sourceLineNo">103</span> " because not active (state="+state.toString()+")");<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> @Override<a name="line.107"></a> -<span class="sourceLineNo">108</span> public C getInstance() {<a name="line.108"></a> -<span class="sourceLineNo">109</span> return impl;<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> @Override<a name="line.112"></a> -<span class="sourceLineNo">113</span> public ClassLoader getClassLoader() {<a name="line.113"></a> -<span class="sourceLineNo">114</span> return classLoader;<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> @Override<a name="line.117"></a> -<span class="sourceLineNo">118</span> public int getPriority() {<a name="line.118"></a> -<span class="sourceLineNo">119</span> return priority;<a name="line.119"></a> -<span class="sourceLineNo">120</span> }<a name="line.120"></a> -<span class="sourceLineNo">121</span><a name="line.121"></a> -<span class="sourceLineNo">122</span> @Override<a name="line.122"></a> -<span class="sourceLineNo">123</span> public int getLoadSequence() {<a name="line.123"></a> -<span class="sourceLineNo">124</span> return seq;<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> /** @return the coprocessor environment version */<a name="line.127"></a> -<span class="sourceLineNo">128</span> @Override<a name="line.128"></a> -<span class="sourceLineNo">129</span> public int getVersion() {<a name="line.129"></a> -<span class="sourceLineNo">130</span> return Coprocessor.VERSION;<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> /** @return the HBase release */<a name="line.133"></a> -<span class="sourceLineNo">134</span> @Override<a name="line.134"></a> -<span class="sourceLineNo">135</span> public String getHBaseVersion() {<a name="line.135"></a> -<span class="sourceLineNo">136</span> return VersionInfo.getVersion();<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> @Override<a name="line.139"></a> -<span class="sourceLineNo">140</span> public Configuration getConfiguration() {<a name="line.140"></a> -<span class="sourceLineNo">141</span> return conf;<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">054</span> public BaseEnvironment(final C impl, final int priority, final int seq, final Configuration conf) {<a name="line.54"></a> +<span class="sourceLineNo">055</span> this.impl = impl;<a name="line.55"></a> +<span class="sourceLineNo">056</span> this.classLoader = impl.getClass().getClassLoader();<a name="line.56"></a> +<span class="sourceLineNo">057</span> this.priority = priority;<a name="line.57"></a> +<span class="sourceLineNo">058</span> this.state = Coprocessor.State.INSTALLED;<a name="line.58"></a> +<span class="sourceLineNo">059</span> this.seq = seq;<a name="line.59"></a> +<span class="sourceLineNo">060</span> this.conf = conf;<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> /** Initialize the environment */<a name="line.63"></a> +<span class="sourceLineNo">064</span> @Override<a name="line.64"></a> +<span class="sourceLineNo">065</span> public void startup() throws IOException {<a name="line.65"></a> +<span class="sourceLineNo">066</span> if (state == Coprocessor.State.INSTALLED ||<a name="line.66"></a> +<span class="sourceLineNo">067</span> state == Coprocessor.State.STOPPED) {<a name="line.67"></a> +<span class="sourceLineNo">068</span> state = Coprocessor.State.STARTING;<a name="line.68"></a> +<span class="sourceLineNo">069</span> Thread currentThread = Thread.currentThread();<a name="line.69"></a> +<span class="sourceLineNo">070</span> ClassLoader hostClassLoader = currentThread.getContextClassLoader();<a name="line.70"></a> +<span class="sourceLineNo">071</span> try {<a name="line.71"></a> +<span class="sourceLineNo">072</span> currentThread.setContextClassLoader(this.getClassLoader());<a name="line.72"></a> +<span class="sourceLineNo">073</span> impl.start(this);<a name="line.73"></a> +<span class="sourceLineNo">074</span> state = Coprocessor.State.ACTIVE;<a name="line.74"></a> +<span class="sourceLineNo">075</span> } finally {<a name="line.75"></a> +<span class="sourceLineNo">076</span> currentThread.setContextClassLoader(hostClassLoader);<a name="line.76"></a> +<span class="sourceLineNo">077</span> }<a name="line.77"></a> +<span class="sourceLineNo">078</span> } else {<a name="line.78"></a> +<span class="sourceLineNo">079</span> LOG.warn("Not starting coprocessor " + impl.getClass().getName() +<a name="line.79"></a> +<span class="sourceLineNo">080</span> " because not inactive (state=" + state.toString() + ")");<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><a name="line.83"></a> +<span class="sourceLineNo">084</span> /** Clean up the environment */<a name="line.84"></a> +<span class="sourceLineNo">085</span> @Override<a name="line.85"></a> +<span class="sourceLineNo">086</span> public void shutdown() {<a name="line.86"></a> +<span class="sourceLineNo">087</span> if (state == Coprocessor.State.ACTIVE) {<a name="line.87"></a> +<span class="sourceLineNo">088</span> state = Coprocessor.State.STOPPING;<a name="line.88"></a> +<span class="sourceLineNo">089</span> Thread currentThread = Thread.currentThread();<a name="line.89"></a> +<span class="sourceLineNo">090</span> ClassLoader hostClassLoader = currentThread.getContextClassLoader();<a name="line.90"></a> +<span class="sourceLineNo">091</span> try {<a name="line.91"></a> +<span class="sourceLineNo">092</span> currentThread.setContextClassLoader(this.getClassLoader());<a name="line.92"></a> +<span class="sourceLineNo">093</span> impl.stop(this);<a name="line.93"></a> +<span class="sourceLineNo">094</span> state = Coprocessor.State.STOPPED;<a name="line.94"></a> +<span class="sourceLineNo">095</span> } catch (IOException ioe) {<a name="line.95"></a> +<span class="sourceLineNo">096</span> LOG.error("Error stopping coprocessor "+impl.getClass().getName(), ioe);<a name="line.96"></a> +<span class="sourceLineNo">097</span> } finally {<a name="line.97"></a> +<span class="sourceLineNo">098</span> currentThread.setContextClassLoader(hostClassLoader);<a name="line.98"></a> +<span class="sourceLineNo">099</span> }<a name="line.99"></a> +<span class="sourceLineNo">100</span> } else {<a name="line.100"></a> +<span class="sourceLineNo">101</span> LOG.warn("Not stopping coprocessor "+impl.getClass().getName()+<a name="line.101"></a> +<span class="sourceLineNo">102</span> " because not active (state="+state.toString()+")");<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> @Override<a name="line.106"></a> +<span class="sourceLineNo">107</span> public C getInstance() {<a name="line.107"></a> +<span class="sourceLineNo">108</span> return impl;<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> @Override<a name="line.111"></a> +<span class="sourceLineNo">112</span> public ClassLoader getClassLoader() {<a name="line.112"></a> +<span class="sourceLineNo">113</span> return classLoader;<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 int getPriority() {<a name="line.117"></a> +<span class="sourceLineNo">118</span> return priority;<a name="line.118"></a> +<span class="sourceLineNo">119</span> }<a name="line.119"></a> +<span class="sourceLineNo">120</span><a name="line.120"></a> +<span class="sourceLineNo">121</span> @Override<a name="line.121"></a> +<span class="sourceLineNo">122</span> public int getLoadSequence() {<a name="line.122"></a> +<span class="sourceLineNo">123</span> return seq;<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> /** @return the coprocessor environment version */<a name="line.126"></a> +<span class="sourceLineNo">127</span> @Override<a name="line.127"></a> +<span class="sourceLineNo">128</span> public int getVersion() {<a name="line.128"></a> +<span class="sourceLineNo">129</span> return Coprocessor.VERSION;<a name="line.129"></a> +<span class="sourceLineNo">130</span> }<a name="line.130"></a> +<span class="sourceLineNo">131</span><a name="line.131"></a> +<span class="sourceLineNo">132</span> /** @return the HBase release */<a name="line.132"></a> +<span class="sourceLineNo">133</span> @Override<a name="line.133"></a> +<span class="sourceLineNo">134</span> public String getHBaseVersion() {<a name="line.134"></a> +<span class="sourceLineNo">135</span> return VersionInfo.getVersion();<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> @Override<a name="line.138"></a> +<span class="sourceLineNo">139</span> public Configuration getConfiguration() {<a name="line.139"></a> +<span class="sourceLineNo">140</span> return conf;<a name="line.140"></a> +<span class="sourceLineNo">141</span> }<a name="line.141"></a> +<span class="sourceLineNo">142</span>}<a name="line.142"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoreCoprocessor.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoreCoprocessor.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoreCoprocessor.html new file mode 100644 index 0000000..d6df0ce --- /dev/null +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/CoreCoprocessor.html @@ -0,0 +1,117 @@ +<!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> *<a name="line.2"></a> +<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> +<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> +<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> +<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> +<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> +<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> +<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> +<span class="sourceLineNo">012</span> *<a name="line.12"></a> +<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> +<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> +<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> +<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> +<span class="sourceLineNo">017</span> * limitations under the License.<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.coprocessor;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.lang.annotation.ElementType;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.lang.annotation.Inherited;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import java.lang.annotation.Retention;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import java.lang.annotation.RetentionPolicy;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import java.lang.annotation.Target;<a name="line.27"></a> +<span class="sourceLineNo">028</span><a name="line.28"></a> +<span class="sourceLineNo">029</span>/**<a name="line.29"></a> +<span class="sourceLineNo">030</span> * Marker annotation that denotes Coprocessors that are core to HBase.<a name="line.30"></a> +<span class="sourceLineNo">031</span> * A Core Coprocessor is a CP that realizes a core HBase feature. Features are sometimes<a name="line.31"></a> +<span class="sourceLineNo">032</span> * implemented first as a Coprocessor to prove viability. The idea is that once proven, they then<a name="line.32"></a> +<span class="sourceLineNo">033</span> * migrate to core. Meantime, HBase Core Coprocessors get this annotation. No other Coprocessors<a name="line.33"></a> +<span class="sourceLineNo">034</span> * can carry this annotation.<a name="line.34"></a> +<span class="sourceLineNo">035</span> */<a name="line.35"></a> +<span class="sourceLineNo">036</span>// Core Coprocessors are generally naughty making use of HBase internals doing accesses no<a name="line.36"></a> +<span class="sourceLineNo">037</span>// Coprocessor should be up to so we mark these special Coprocessors with this annotation and on<a name="line.37"></a> +<span class="sourceLineNo">038</span>// Coprocessor load, we'll give these Coprocessors a 'richer' Environment with access to internals<a name="line.38"></a> +<span class="sourceLineNo">039</span>// not allowed other Coprocessors. see the *CoprocessorHost where they do the Coprocessor loadings.<a name="line.39"></a> +<span class="sourceLineNo">040</span>@Target(ElementType.TYPE)<a name="line.40"></a> +<span class="sourceLineNo">041</span>@Inherited<a name="line.41"></a> +<span class="sourceLineNo">042</span>@InterfaceAudience.Private<a name="line.42"></a> +<span class="sourceLineNo">043</span>@Retention(RetentionPolicy.RUNTIME)<a name="line.43"></a> +<span class="sourceLineNo">044</span>// This Annotation is not @Documented because I don't want users figuring out its mechanics.<a name="line.44"></a> +<span class="sourceLineNo">045</span>public @interface CoreCoprocessor {}<a name="line.45"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/HasMasterServices.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/HasMasterServices.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/HasMasterServices.html new file mode 100644 index 0000000..a5ff75d --- /dev/null +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/HasMasterServices.html @@ -0,0 +1,109 @@ +<!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.coprocessor;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.master.MasterServices;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>/**<a name="line.23"></a> +<span class="sourceLineNo">024</span> * Mark a class that it has a MasterServices accessor.<a name="line.24"></a> +<span class="sourceLineNo">025</span> * Temporary hack until core Coprocesssors are integrated.<a name="line.25"></a> +<span class="sourceLineNo">026</span> * @see CoreCoprocessor<a name="line.26"></a> +<span class="sourceLineNo">027</span> * @deprecated Since 2.0.0 to be removed in 3.0.0. The hope is that by 3.0.0 we will not need this<a name="line.27"></a> +<span class="sourceLineNo">028</span> * facility as CoreCoprocessors are integated into core.<a name="line.28"></a> +<span class="sourceLineNo">029</span> */<a name="line.29"></a> +<span class="sourceLineNo">030</span>@Deprecated<a name="line.30"></a> +<span class="sourceLineNo">031</span>@InterfaceAudience.Private<a name="line.31"></a> +<span class="sourceLineNo">032</span>public interface HasMasterServices {<a name="line.32"></a> +<span class="sourceLineNo">033</span> /**<a name="line.33"></a> +<span class="sourceLineNo">034</span> * @return An instance of RegionServerServices, an object NOT for Coprocessor consumption.<a name="line.34"></a> +<span class="sourceLineNo">035</span> */<a name="line.35"></a> +<span class="sourceLineNo">036</span> MasterServices getMasterServices();<a name="line.36"></a> +<span class="sourceLineNo">037</span>}<a name="line.37"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/HasRegionServerServices.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/HasRegionServerServices.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/HasRegionServerServices.html new file mode 100644 index 0000000..412a5c7 --- /dev/null +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/HasRegionServerServices.html @@ -0,0 +1,109 @@ +<!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.coprocessor;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.regionserver.RegionServerServices;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.21"></a> +<span class="sourceLineNo">022</span><a name="line.22"></a> +<span class="sourceLineNo">023</span>/**<a name="line.23"></a> +<span class="sourceLineNo">024</span> * Mark a class that it has a RegionServiceServices accessor.<a name="line.24"></a> +<span class="sourceLineNo">025</span> * Temporary hack until core Coprocesssors are integrated.<a name="line.25"></a> +<span class="sourceLineNo">026</span> * @see CoreCoprocessor<a name="line.26"></a> +<span class="sourceLineNo">027</span> * @deprecated Since 2.0.0 to be removed in 3.0.0. The hope is that by 3.0.0 we will not need this<a name="line.27"></a> +<span class="sourceLineNo">028</span> * facility as CoreCoprocessors are integated into core.<a name="line.28"></a> +<span class="sourceLineNo">029</span> */<a name="line.29"></a> +<span class="sourceLineNo">030</span>@Deprecated<a name="line.30"></a> +<span class="sourceLineNo">031</span>@InterfaceAudience.Private<a name="line.31"></a> +<span class="sourceLineNo">032</span>public interface HasRegionServerServices {<a name="line.32"></a> +<span class="sourceLineNo">033</span> /**<a name="line.33"></a> +<span class="sourceLineNo">034</span> * @return An instance of RegionServerServices, an object NOT for Coprocessor consumption.<a name="line.34"></a> +<span class="sourceLineNo">035</span> */<a name="line.35"></a> +<span class="sourceLineNo">036</span> RegionServerServices getRegionServerServices();<a name="line.36"></a> +<span class="sourceLineNo">037</span>}<a name="line.37"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html index e9bcd0b..d908d95 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/MasterCoprocessorEnvironment.html @@ -27,28 +27,46 @@ <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>package org.apache.hadoop.hbase.coprocessor;<a name="line.20"></a> <span class="sourceLineNo">021</span><a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.master.MasterServices;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.metrics.MetricRegistry;<a name="line.27"></a> -<span class="sourceLineNo">028</span><a name="line.28"></a> -<span class="sourceLineNo">029</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.29"></a> -<span class="sourceLineNo">030</span>@InterfaceStability.Evolving<a name="line.30"></a> -<span class="sourceLineNo">031</span>public interface MasterCoprocessorEnvironment extends CoprocessorEnvironment<MasterCoprocessor> {<a name="line.31"></a> -<span class="sourceLineNo">032</span> /** @return reference to the HMaster services */<a name="line.32"></a> -<span class="sourceLineNo">033</span> MasterServices getMasterServices();<a name="line.33"></a> -<span class="sourceLineNo">034</span><a name="line.34"></a> -<span class="sourceLineNo">035</span> /**<a name="line.35"></a> -<span class="sourceLineNo">036</span> * Returns a MetricRegistry that can be used to track metrics at the master level.<a name="line.36"></a> -<span class="sourceLineNo">037</span> *<a name="line.37"></a> -<span class="sourceLineNo">038</span> * <p>See ExampleMasterObserverWithMetrics class in the hbase-examples modules for examples<a name="line.38"></a> -<span class="sourceLineNo">039</span> * of how metrics can be instantiated and used.</p><a name="line.39"></a> -<span class="sourceLineNo">040</span> * @return A MetricRegistry for the coprocessor class to track and export metrics.<a name="line.40"></a> -<span class="sourceLineNo">041</span> */<a name="line.41"></a> -<span class="sourceLineNo">042</span> MetricRegistry getMetricRegistryForMaster();<a name="line.42"></a> -<span class="sourceLineNo">043</span>}<a name="line.43"></a> +<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.ServerName;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.metrics.MetricRegistry;<a name="line.28"></a> +<span class="sourceLineNo">029</span><a name="line.29"></a> +<span class="sourceLineNo">030</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.30"></a> +<span class="sourceLineNo">031</span>@InterfaceStability.Evolving<a name="line.31"></a> +<span class="sourceLineNo">032</span>public interface MasterCoprocessorEnvironment extends CoprocessorEnvironment<MasterCoprocessor> {<a name="line.32"></a> +<span class="sourceLineNo">033</span> /**<a name="line.33"></a> +<span class="sourceLineNo">034</span> * @return Hosting Server's ServerName<a name="line.34"></a> +<span class="sourceLineNo">035</span> */<a name="line.35"></a> +<span class="sourceLineNo">036</span> ServerName getServerName();<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Be careful RPC'ing from a Coprocessor context.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * RPC's will fail, stall, retry, and/or crawl because the remote side is not online, is<a name="line.40"></a> +<span class="sourceLineNo">041</span> * struggling or it is on the other side of a network partition. Any use of Connection from<a name="line.41"></a> +<span class="sourceLineNo">042</span> * inside a Coprocessor must be able to handle all such hiccups.<a name="line.42"></a> +<span class="sourceLineNo">043</span> *<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p>Using a Connection to get at a local resource -- say a Region that is on the local<a name="line.44"></a> +<span class="sourceLineNo">045</span> * Server or using Admin Interface from a Coprocessor hosted on the Master -- will result in a<a name="line.45"></a> +<span class="sourceLineNo">046</span> * short-circuit of the RPC framework to make a direct invocation avoiding RPC (and<a name="line.46"></a> +<span class="sourceLineNo">047</span> * protobuf marshalling/unmarshalling).<a name="line.47"></a> +<span class="sourceLineNo">048</span> *<a name="line.48"></a> +<span class="sourceLineNo">049</span> * @return The host's Connection to the Cluster.<a name="line.49"></a> +<span class="sourceLineNo">050</span> */<a name="line.50"></a> +<span class="sourceLineNo">051</span> Connection getConnection();<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> * Returns a MetricRegistry that can be used to track metrics at the master level.<a name="line.54"></a> +<span class="sourceLineNo">055</span> *<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p>See ExampleMasterObserverWithMetrics class in the hbase-examples modules for examples<a name="line.56"></a> +<span class="sourceLineNo">057</span> * of how metrics can be instantiated and used.</p><a name="line.57"></a> +<span class="sourceLineNo">058</span> * @return A MetricRegistry for the coprocessor class to track and export metrics.<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span> MetricRegistry getMetricRegistryForMaster();<a name="line.60"></a> +<span class="sourceLineNo">061</span>}<a name="line.61"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.html index 26e1213..dc4644b 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionCoprocessorEnvironment.html @@ -31,45 +31,63 @@ <span class="sourceLineNo">023</span><a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.24"></a> <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.metrics.MetricRegistry;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.regionserver.CoprocessorRegionServerServices;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.regionserver.Region;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.31"></a> -<span class="sourceLineNo">032</span><a name="line.32"></a> -<span class="sourceLineNo">033</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.33"></a> -<span class="sourceLineNo">034</span>@InterfaceStability.Evolving<a name="line.34"></a> -<span class="sourceLineNo">035</span>public interface RegionCoprocessorEnvironment extends CoprocessorEnvironment<RegionCoprocessor> {<a name="line.35"></a> -<span class="sourceLineNo">036</span> /** @return the region associated with this coprocessor */<a name="line.36"></a> -<span class="sourceLineNo">037</span> Region getRegion();<a name="line.37"></a> -<span class="sourceLineNo">038</span><a name="line.38"></a> -<span class="sourceLineNo">039</span> /** @return region information for the region this coprocessor is running on */<a name="line.39"></a> -<span class="sourceLineNo">040</span> RegionInfo getRegionInfo();<a name="line.40"></a> -<span class="sourceLineNo">041</span><a name="line.41"></a> -<span class="sourceLineNo">042</span> /** @return reference to the region server services */<a name="line.42"></a> -<span class="sourceLineNo">043</span> CoprocessorRegionServerServices getCoprocessorRegionServerServices();<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span> /** @return shared data between all instances of this coprocessor */<a name="line.45"></a> -<span class="sourceLineNo">046</span> ConcurrentMap<String, Object> getSharedData();<a name="line.46"></a> -<span class="sourceLineNo">047</span><a name="line.47"></a> -<span class="sourceLineNo">048</span> /**<a name="line.48"></a> -<span class="sourceLineNo">049</span> * Returns a MetricRegistry that can be used to track metrics at the region server level. All<a name="line.49"></a> -<span class="sourceLineNo">050</span> * metrics tracked at this level will be shared by all the coprocessor instances<a name="line.50"></a> -<span class="sourceLineNo">051</span> * of the same class in the same region server process. Note that there will be one<a name="line.51"></a> -<span class="sourceLineNo">052</span> * region coprocessor environment per region in the server, but all of these instances will share<a name="line.52"></a> -<span class="sourceLineNo">053</span> * the same MetricRegistry. The metric instances (like Counter, Timer, etc) will also be shared<a name="line.53"></a> -<span class="sourceLineNo">054</span> * among all of the region coprocessor instances.<a name="line.54"></a> -<span class="sourceLineNo">055</span> *<a name="line.55"></a> -<span class="sourceLineNo">056</span> * <p>See ExampleRegionObserverWithMetrics class in the hbase-examples modules to see examples of how<a name="line.56"></a> -<span class="sourceLineNo">057</span> * metrics can be instantiated and used.</p><a name="line.57"></a> -<span class="sourceLineNo">058</span> * @return A MetricRegistry for the coprocessor class to track and export metrics.<a name="line.58"></a> -<span class="sourceLineNo">059</span> */<a name="line.59"></a> -<span class="sourceLineNo">060</span> // Note: we are not exposing getMetricRegistryForRegion(). per-region metrics are already costly<a name="line.60"></a> -<span class="sourceLineNo">061</span> // so we do not want to allow coprocessors to export metrics at the region level. We can allow<a name="line.61"></a> -<span class="sourceLineNo">062</span> // getMetricRegistryForTable() to allow coprocessors to track metrics per-table, per-regionserver.<a name="line.62"></a> -<span class="sourceLineNo">063</span> MetricRegistry getMetricRegistryForRegionServer();<a name="line.63"></a> -<span class="sourceLineNo">064</span>}<a name="line.64"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.ServerName;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.metrics.MetricRegistry;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.regionserver.Region;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.32"></a> +<span class="sourceLineNo">033</span><a name="line.33"></a> +<span class="sourceLineNo">034</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.34"></a> +<span class="sourceLineNo">035</span>@InterfaceStability.Evolving<a name="line.35"></a> +<span class="sourceLineNo">036</span>public interface RegionCoprocessorEnvironment extends CoprocessorEnvironment<RegionCoprocessor> {<a name="line.36"></a> +<span class="sourceLineNo">037</span> /** @return the region associated with this coprocessor */<a name="line.37"></a> +<span class="sourceLineNo">038</span> Region getRegion();<a name="line.38"></a> +<span class="sourceLineNo">039</span><a name="line.39"></a> +<span class="sourceLineNo">040</span> /** @return region information for the region this coprocessor is running on */<a name="line.40"></a> +<span class="sourceLineNo">041</span> RegionInfo getRegionInfo();<a name="line.41"></a> +<span class="sourceLineNo">042</span><a name="line.42"></a> +<span class="sourceLineNo">043</span> /** @return shared data between all instances of this coprocessor */<a name="line.43"></a> +<span class="sourceLineNo">044</span> ConcurrentMap<String, Object> getSharedData();<a name="line.44"></a> +<span class="sourceLineNo">045</span><a name="line.45"></a> +<span class="sourceLineNo">046</span> /**<a name="line.46"></a> +<span class="sourceLineNo">047</span> * @return Hosting Server's ServerName<a name="line.47"></a> +<span class="sourceLineNo">048</span> */<a name="line.48"></a> +<span class="sourceLineNo">049</span> ServerName getServerName();<a name="line.49"></a> +<span class="sourceLineNo">050</span><a name="line.50"></a> +<span class="sourceLineNo">051</span> /**<a name="line.51"></a> +<span class="sourceLineNo">052</span> * Be careful RPC'ing from a Coprocessor context.<a name="line.52"></a> +<span class="sourceLineNo">053</span> * RPC's will fail, stall, retry, and/or crawl because the remote side is not online, is<a name="line.53"></a> +<span class="sourceLineNo">054</span> * struggling or it is on the other side of a network partition. Any use of Connection from<a name="line.54"></a> +<span class="sourceLineNo">055</span> * inside a Coprocessor must be able to handle all such hiccups.<a name="line.55"></a> +<span class="sourceLineNo">056</span> *<a name="line.56"></a> +<span class="sourceLineNo">057</span> * <p>Using a Connection to get at a local resource -- say a Region that is on the local<a name="line.57"></a> +<span class="sourceLineNo">058</span> * Server or using Admin Interface from a Coprocessor hosted on the Master -- will result in a<a name="line.58"></a> +<span class="sourceLineNo">059</span> * short-circuit of the RPC framework to make a direct invocation avoiding RPC (and<a name="line.59"></a> +<span class="sourceLineNo">060</span> * protobuf marshalling/unmarshalling).<a name="line.60"></a> +<span class="sourceLineNo">061</span> *<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @return The host's Connection to the Cluster.<a name="line.62"></a> +<span class="sourceLineNo">063</span> */<a name="line.63"></a> +<span class="sourceLineNo">064</span> Connection getConnection();<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> * Returns a MetricRegistry that can be used to track metrics at the region server level. All<a name="line.67"></a> +<span class="sourceLineNo">068</span> * metrics tracked at this level will be shared by all the coprocessor instances<a name="line.68"></a> +<span class="sourceLineNo">069</span> * of the same class in the same region server process. Note that there will be one<a name="line.69"></a> +<span class="sourceLineNo">070</span> * region coprocessor environment per region in the server, but all of these instances will share<a name="line.70"></a> +<span class="sourceLineNo">071</span> * the same MetricRegistry. The metric instances (like Counter, Timer, etc) will also be shared<a name="line.71"></a> +<span class="sourceLineNo">072</span> * among all of the region coprocessor instances.<a name="line.72"></a> +<span class="sourceLineNo">073</span> *<a name="line.73"></a> +<span class="sourceLineNo">074</span> * <p>See ExampleRegionObserverWithMetrics class in the hbase-examples modules to see examples of how<a name="line.74"></a> +<span class="sourceLineNo">075</span> * metrics can be instantiated and used.</p><a name="line.75"></a> +<span class="sourceLineNo">076</span> * @return A MetricRegistry for the coprocessor class to track and export metrics.<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> // Note: we are not exposing getMetricRegistryForRegion(). per-region metrics are already costly<a name="line.78"></a> +<span class="sourceLineNo">079</span> // so we do not want to allow coprocessors to export metrics at the region level. We can allow<a name="line.79"></a> +<span class="sourceLineNo">080</span> // getMetricRegistryForTable() to allow coprocessors to track metrics per-table, per-regionserver.<a name="line.80"></a> +<span class="sourceLineNo">081</span> MetricRegistry getMetricRegistryForRegionServer();<a name="line.81"></a> +<span class="sourceLineNo">082</span>}<a name="line.82"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionServerCoprocessorEnvironment.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionServerCoprocessorEnvironment.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionServerCoprocessorEnvironment.html index a9e0baf..bae40f7 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionServerCoprocessorEnvironment.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionServerCoprocessorEnvironment.html @@ -6,7 +6,7 @@ </head> <body> <div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> <span class="sourceLineNo">002</span> *<a name="line.2"></a> <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> @@ -28,31 +28,45 @@ <span class="sourceLineNo">020</span><a name="line.20"></a> <span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.21"></a> <span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.metrics.MetricRegistry;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.regionserver.CoprocessorRegionServerServices;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.26"></a> -<span class="sourceLineNo">027</span><a name="line.27"></a> -<span class="sourceLineNo">028</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.28"></a> -<span class="sourceLineNo">029</span>@InterfaceStability.Evolving<a name="line.29"></a> -<span class="sourceLineNo">030</span>public interface RegionServerCoprocessorEnvironment<a name="line.30"></a> -<span class="sourceLineNo">031</span> extends CoprocessorEnvironment<RegionServerCoprocessor> {<a name="line.31"></a> -<span class="sourceLineNo">032</span> /**<a name="line.32"></a> -<span class="sourceLineNo">033</span> * Gets the region server services.<a name="line.33"></a> -<span class="sourceLineNo">034</span> *<a name="line.34"></a> -<span class="sourceLineNo">035</span> * @return the region server services<a name="line.35"></a> -<span class="sourceLineNo">036</span> */<a name="line.36"></a> -<span class="sourceLineNo">037</span> CoprocessorRegionServerServices getCoprocessorRegionServerServices();<a name="line.37"></a> -<span class="sourceLineNo">038</span><a name="line.38"></a> -<span class="sourceLineNo">039</span> /**<a name="line.39"></a> -<span class="sourceLineNo">040</span> * Returns a MetricRegistry that can be used to track metrics at the region server level.<a name="line.40"></a> -<span class="sourceLineNo">041</span> *<a name="line.41"></a> -<span class="sourceLineNo">042</span> * <p>See ExampleMasterObserverWithMetrics class in the hbase-examples modules for examples<a name="line.42"></a> -<span class="sourceLineNo">043</span> * of how metrics can be instantiated and used.</p><a name="line.43"></a> -<span class="sourceLineNo">044</span> * @return A MetricRegistry for the coprocessor class to track and export metrics.<a name="line.44"></a> -<span class="sourceLineNo">045</span> */<a name="line.45"></a> -<span class="sourceLineNo">046</span> MetricRegistry getMetricRegistryForRegionServer();<a name="line.46"></a> -<span class="sourceLineNo">047</span>}<a name="line.47"></a> +<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.ServerName;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.metrics.MetricRegistry;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.27"></a> +<span class="sourceLineNo">028</span><a name="line.28"></a> +<span class="sourceLineNo">029</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.29"></a> +<span class="sourceLineNo">030</span>@InterfaceStability.Evolving<a name="line.30"></a> +<span class="sourceLineNo">031</span>public interface RegionServerCoprocessorEnvironment<a name="line.31"></a> +<span class="sourceLineNo">032</span> extends CoprocessorEnvironment<RegionServerCoprocessor> {<a name="line.32"></a> +<span class="sourceLineNo">033</span> /**<a name="line.33"></a> +<span class="sourceLineNo">034</span> * @return Hosting Server's ServerName<a name="line.34"></a> +<span class="sourceLineNo">035</span> */<a name="line.35"></a> +<span class="sourceLineNo">036</span> ServerName getServerName();<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Be careful RPC'ing from a Coprocessor context.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * RPC's will fail, stall, retry, and/or crawl because the remote side is not online, is<a name="line.40"></a> +<span class="sourceLineNo">041</span> * struggling or it is on the other side of a network partition. Any use of Connection from<a name="line.41"></a> +<span class="sourceLineNo">042</span> * inside a Coprocessor must be able to handle all such hiccups.<a name="line.42"></a> +<span class="sourceLineNo">043</span> *<a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p>Using a Connection to get at a local resource -- say a Region that is on the local<a name="line.44"></a> +<span class="sourceLineNo">045</span> * Server or using Admin Interface from a Coprocessor hosted on the Master -- will result in a<a name="line.45"></a> +<span class="sourceLineNo">046</span> * short-circuit of the RPC framework to make a direct invocation avoiding RPC (and<a name="line.46"></a> +<span class="sourceLineNo">047</span> * protobuf marshalling/unmarshalling).<a name="line.47"></a> +<span class="sourceLineNo">048</span> *<a name="line.48"></a> +<span class="sourceLineNo">049</span> * @return The host's Connection to the Cluster.<a name="line.49"></a> +<span class="sourceLineNo">050</span> */<a name="line.50"></a> +<span class="sourceLineNo">051</span> Connection getConnection();<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> * Returns a MetricRegistry that can be used to track metrics at the region server level.<a name="line.54"></a> +<span class="sourceLineNo">055</span> *<a name="line.55"></a> +<span class="sourceLineNo">056</span> * <p>See ExampleMasterObserverWithMetrics class in the hbase-examples modules for examples<a name="line.56"></a> +<span class="sourceLineNo">057</span> * of how metrics can be instantiated and used.</p><a name="line.57"></a> +<span class="sourceLineNo">058</span> * @return A MetricRegistry for the coprocessor class to track and export metrics.<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span> MetricRegistry getMetricRegistryForRegionServer();<a name="line.60"></a> +<span class="sourceLineNo">061</span>}<a name="line.61"></a>