| <!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.client;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import static org.apache.hadoop.hbase.client.ConnectionUtils.retries2Attempts;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.concurrent.TimeUnit;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.HBaseServerException;<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><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>/**<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * For creating {@link AsyncAdmin}. The implementation should have default configurations set before<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * returning the builder to user. So users are free to only set the configs they care about to<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * create a new AsyncAdmin instance.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * @since 2.0.0<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> */<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>@InterfaceAudience.Public<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>public interface AsyncAdminBuilder {<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> * Set timeout for a whole admin operation. Operation timeout and max attempt times(or max retry<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * times) are both limitations for retrying, we will stop retrying when we reach any of the<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * limitations.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @return this for invocation chaining<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> */<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> AsyncAdminBuilder setOperationTimeout(long timeout, TimeUnit unit);<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> * Set timeout for each rpc request.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @return this for invocation chaining<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> AsyncAdminBuilder setRpcTimeout(long timeout, TimeUnit unit);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> /**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * Set the base pause time for retrying. We use an exponential policy to generate sleep time when<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * retrying.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * @return this for invocation chaining<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * @see #setRetryPauseForServerOverloaded(long, TimeUnit)<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> AsyncAdminBuilder setRetryPause(long timeout, TimeUnit unit);<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Set the base pause time for retrying when {@link HBaseServerException#isServerOverloaded()}. We<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * use an exponential policy to generate sleep time from this base when retrying.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <p/><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * This value should be greater than the normal pause value which could be set with the above<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * {@link #setRetryPause(long, TimeUnit)} method, as usually<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * {@link HBaseServerException#isServerOverloaded()} means the server is overloaded. We just use<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * the normal pause value for {@link HBaseServerException#isServerOverloaded()} if here you<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * specify a smaller value.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @see #setRetryPause(long, TimeUnit)<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @deprecated Since 2.5.0, will be removed in 4.0.0. Please use<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * {@link #setRetryPauseForServerOverloaded(long, TimeUnit)} instead.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> @Deprecated<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> default AsyncAdminBuilder setRetryPauseForCQTBE(long pause, TimeUnit unit) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> return setRetryPauseForServerOverloaded(pause, unit);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> }<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> * Set the base pause time for retrying when {@link HBaseServerException#isServerOverloaded()}. We<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * use an exponential policy to generate sleep time when retrying.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <p/><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * This value should be greater than the normal pause value which could be set with the above<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * {@link #setRetryPause(long, TimeUnit)} method, as usually<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * {@link HBaseServerException#isServerOverloaded()} means the server is overloaded. We just use<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * the normal pause value for {@link HBaseServerException#isServerOverloaded()} if here you<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * specify a smaller value.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @see #setRetryPause(long, TimeUnit)<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> AsyncAdminBuilder setRetryPauseForServerOverloaded(long pause, TimeUnit unit);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> /**<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Set the max retry times for an admin operation. Usually it is the max attempt times minus 1.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * Operation timeout and max attempt times(or max retry times) are both limitations for retrying,<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * we will stop retrying when we reach any of the limitations.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @return this for invocation chaining<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> default AsyncAdminBuilder setMaxRetries(int maxRetries) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return setMaxAttempts(retries2Attempts(maxRetries));<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> /**<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * Set the max attempt times for an admin operation. Usually it is the max retry times plus 1.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * Operation timeout and max attempt times(or max retry times) are both limitations for retrying,<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * we will stop retrying when we reach any of the limitations.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @return this for invocation chaining<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> AsyncAdminBuilder setMaxAttempts(int maxAttempts);<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> * Set the number of retries that are allowed before we start to log.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @return this for invocation chaining<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> AsyncAdminBuilder setStartLogErrorsCnt(int startLogErrorsCnt);<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> * Create a {@link AsyncAdmin} instance.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @return a {@link AsyncAdmin} instance<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> */<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> AsyncAdmin build();<a name="line.116"></a> |
| <span class="sourceLineNo">117</span>}<a name="line.117"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
