blob: ca20e75790fadd355a532588d4093330b60bc72f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.client, class: ConnectionFactory">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import static org.apache.hadoop.hbase.util.FutureUtils.addListener;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">import java.io.IOException;</span>
<span class="source-line-no">023</span><span id="line-23">import java.lang.reflect.Constructor;</span>
<span class="source-line-no">024</span><span id="line-24">import java.net.URI;</span>
<span class="source-line-no">025</span><span id="line-25">import java.security.PrivilegedExceptionAction;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.Collections;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.Map;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.concurrent.CompletableFuture;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.concurrent.ExecutorService;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.AuthUtil;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.HBaseConfiguration;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.security.User;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.security.UserProvider;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.trace.TraceUtil;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.util.FutureUtils;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.util.ReflectionUtils;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.util.Strings;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">040</span><span id="line-40">import org.slf4j.Logger;</span>
<span class="source-line-no">041</span><span id="line-41">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.hbase.thirdparty.com.google.common.base.Throwables;</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45">/**</span>
<span class="source-line-no">046</span><span id="line-46"> * A non-instantiable class that manages creation of {@link Connection}s. Managing the lifecycle of</span>
<span class="source-line-no">047</span><span id="line-47"> * the {@link Connection}s to the cluster is the responsibility of the caller. From a</span>
<span class="source-line-no">048</span><span id="line-48"> * {@link Connection}, {@link Table} implementations are retrieved with</span>
<span class="source-line-no">049</span><span id="line-49"> * {@link Connection#getTable(org.apache.hadoop.hbase.TableName)}. Example:</span>
<span class="source-line-no">050</span><span id="line-50"> *</span>
<span class="source-line-no">051</span><span id="line-51"> * &lt;pre&gt;</span>
<span class="source-line-no">052</span><span id="line-52"> * Connection connection = ConnectionFactory.createConnection(config);</span>
<span class="source-line-no">053</span><span id="line-53"> * Table table = connection.getTable(TableName.valueOf("table1"));</span>
<span class="source-line-no">054</span><span id="line-54"> * try {</span>
<span class="source-line-no">055</span><span id="line-55"> * // Use the table as needed, for a single operation and a single thread</span>
<span class="source-line-no">056</span><span id="line-56"> * } finally {</span>
<span class="source-line-no">057</span><span id="line-57"> * table.close();</span>
<span class="source-line-no">058</span><span id="line-58"> * connection.close();</span>
<span class="source-line-no">059</span><span id="line-59"> * }</span>
<span class="source-line-no">060</span><span id="line-60"> * &lt;/pre&gt;</span>
<span class="source-line-no">061</span><span id="line-61"> *</span>
<span class="source-line-no">062</span><span id="line-62"> * Since 2.2.0, Connection created by ConnectionFactory can contain user-specified kerberos</span>
<span class="source-line-no">063</span><span id="line-63"> * credentials if caller has following two configurations set:</span>
<span class="source-line-no">064</span><span id="line-64"> * &lt;ul&gt;</span>
<span class="source-line-no">065</span><span id="line-65"> * &lt;li&gt;hbase.client.keytab.file, points to a valid keytab on the local filesystem</span>
<span class="source-line-no">066</span><span id="line-66"> * &lt;li&gt;hbase.client.kerberos.principal, gives the Kerberos principal to use</span>
<span class="source-line-no">067</span><span id="line-67"> * &lt;/ul&gt;</span>
<span class="source-line-no">068</span><span id="line-68"> * By this way, caller can directly connect to kerberized cluster without caring login and</span>
<span class="source-line-no">069</span><span id="line-69"> * credentials renewal logic in application.</span>
<span class="source-line-no">070</span><span id="line-70"> *</span>
<span class="source-line-no">071</span><span id="line-71"> * &lt;pre&gt;</span>
<span class="source-line-no">072</span><span id="line-72"> * &lt;/pre&gt;</span>
<span class="source-line-no">073</span><span id="line-73"> *</span>
<span class="source-line-no">074</span><span id="line-74"> * Similarly, {@link Connection} also returns {@link Admin} and {@link RegionLocator}</span>
<span class="source-line-no">075</span><span id="line-75"> * implementations.</span>
<span class="source-line-no">076</span><span id="line-76"> * @see Connection</span>
<span class="source-line-no">077</span><span id="line-77"> * @since 0.99.0</span>
<span class="source-line-no">078</span><span id="line-78"> */</span>
<span class="source-line-no">079</span><span id="line-79">@InterfaceAudience.Public</span>
<span class="source-line-no">080</span><span id="line-80">public class ConnectionFactory {</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82"> private static final Logger LOG = LoggerFactory.getLogger(ConnectionFactory.class);</span>
<span class="source-line-no">083</span><span id="line-83"></span>
<span class="source-line-no">084</span><span id="line-84"> public static final String HBASE_CLIENT_ASYNC_CONNECTION_IMPL =</span>
<span class="source-line-no">085</span><span id="line-85"> "hbase.client.async.connection.impl";</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> /** No public c.tors */</span>
<span class="source-line-no">088</span><span id="line-88"> protected ConnectionFactory() {</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"></span>
<span class="source-line-no">091</span><span id="line-91"> /**</span>
<span class="source-line-no">092</span><span id="line-92"> * Create a new Connection instance using default HBaseConfiguration. Connection encapsulates all</span>
<span class="source-line-no">093</span><span id="line-93"> * housekeeping for a connection to the cluster. All tables and interfaces created from returned</span>
<span class="source-line-no">094</span><span id="line-94"> * connection share zookeeper connection, meta cache, and connections to region servers and</span>
<span class="source-line-no">095</span><span id="line-95"> * masters. &lt;br&gt;</span>
<span class="source-line-no">096</span><span id="line-96"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">097</span><span id="line-97"> * instance. Typical usage:</span>
<span class="source-line-no">098</span><span id="line-98"> *</span>
<span class="source-line-no">099</span><span id="line-99"> * &lt;pre&gt;</span>
<span class="source-line-no">100</span><span id="line-100"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">101</span><span id="line-101"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">102</span><span id="line-102"> * table.get(...);</span>
<span class="source-line-no">103</span><span id="line-103"> * ...</span>
<span class="source-line-no">104</span><span id="line-104"> * }</span>
<span class="source-line-no">105</span><span id="line-105"> * &lt;/pre&gt;</span>
<span class="source-line-no">106</span><span id="line-106"> *</span>
<span class="source-line-no">107</span><span id="line-107"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">108</span><span id="line-108"> */</span>
<span class="source-line-no">109</span><span id="line-109"> public static Connection createConnection() throws IOException {</span>
<span class="source-line-no">110</span><span id="line-110"> return createConnection(HBaseConfiguration.create());</span>
<span class="source-line-no">111</span><span id="line-111"> }</span>
<span class="source-line-no">112</span><span id="line-112"></span>
<span class="source-line-no">113</span><span id="line-113"> /**</span>
<span class="source-line-no">114</span><span id="line-114"> * Create a new Connection instance using default HBaseConfiguration. Connection encapsulates all</span>
<span class="source-line-no">115</span><span id="line-115"> * housekeeping for a connection to the cluster. All tables and interfaces created from returned</span>
<span class="source-line-no">116</span><span id="line-116"> * connection share zookeeper connection, meta cache, and connections to region servers and</span>
<span class="source-line-no">117</span><span id="line-117"> * masters. &lt;br&gt;</span>
<span class="source-line-no">118</span><span id="line-118"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">119</span><span id="line-119"> * instance. Typical usage:</span>
<span class="source-line-no">120</span><span id="line-120"> *</span>
<span class="source-line-no">121</span><span id="line-121"> * &lt;pre&gt;</span>
<span class="source-line-no">122</span><span id="line-122"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">123</span><span id="line-123"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">124</span><span id="line-124"> * table.get(...);</span>
<span class="source-line-no">125</span><span id="line-125"> * ...</span>
<span class="source-line-no">126</span><span id="line-126"> * }</span>
<span class="source-line-no">127</span><span id="line-127"> * &lt;/pre&gt;</span>
<span class="source-line-no">128</span><span id="line-128"> *</span>
<span class="source-line-no">129</span><span id="line-129"> * @param connectionUri the connection uri for the hbase cluster</span>
<span class="source-line-no">130</span><span id="line-130"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">131</span><span id="line-131"> */</span>
<span class="source-line-no">132</span><span id="line-132"> public static Connection createConnection(URI connectionUri) throws IOException {</span>
<span class="source-line-no">133</span><span id="line-133"> return createConnection(connectionUri, HBaseConfiguration.create());</span>
<span class="source-line-no">134</span><span id="line-134"> }</span>
<span class="source-line-no">135</span><span id="line-135"></span>
<span class="source-line-no">136</span><span id="line-136"> /**</span>
<span class="source-line-no">137</span><span id="line-137"> * Create a new Connection instance using the passed &lt;code&gt;conf&lt;/code&gt; instance. Connection</span>
<span class="source-line-no">138</span><span id="line-138"> * encapsulates all housekeeping for a connection to the cluster. All tables and interfaces</span>
<span class="source-line-no">139</span><span id="line-139"> * created from returned connection share zookeeper connection(if used), meta cache, and</span>
<span class="source-line-no">140</span><span id="line-140"> * connections to region servers and masters. &lt;br&gt;</span>
<span class="source-line-no">141</span><span id="line-141"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">142</span><span id="line-142"> * instance. Typical usage:</span>
<span class="source-line-no">143</span><span id="line-143"> *</span>
<span class="source-line-no">144</span><span id="line-144"> * &lt;pre&gt;</span>
<span class="source-line-no">145</span><span id="line-145"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">146</span><span id="line-146"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">147</span><span id="line-147"> * table.get(...);</span>
<span class="source-line-no">148</span><span id="line-148"> * ...</span>
<span class="source-line-no">149</span><span id="line-149"> * }</span>
<span class="source-line-no">150</span><span id="line-150"> * &lt;/pre&gt;</span>
<span class="source-line-no">151</span><span id="line-151"> *</span>
<span class="source-line-no">152</span><span id="line-152"> * @param conf configuration</span>
<span class="source-line-no">153</span><span id="line-153"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">154</span><span id="line-154"> */</span>
<span class="source-line-no">155</span><span id="line-155"> public static Connection createConnection(Configuration conf) throws IOException {</span>
<span class="source-line-no">156</span><span id="line-156"> return createConnection(conf, null, AuthUtil.loginClient(conf));</span>
<span class="source-line-no">157</span><span id="line-157"> }</span>
<span class="source-line-no">158</span><span id="line-158"></span>
<span class="source-line-no">159</span><span id="line-159"> /**</span>
<span class="source-line-no">160</span><span id="line-160"> * Create a new Connection instance using the passed &lt;code&gt;conf&lt;/code&gt; instance. Connection</span>
<span class="source-line-no">161</span><span id="line-161"> * encapsulates all housekeeping for a connection to the cluster. All tables and interfaces</span>
<span class="source-line-no">162</span><span id="line-162"> * created from returned connection share zookeeper connection(if used), meta cache, and</span>
<span class="source-line-no">163</span><span id="line-163"> * connections to region servers and masters. &lt;br&gt;</span>
<span class="source-line-no">164</span><span id="line-164"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">165</span><span id="line-165"> * instance. Typical usage:</span>
<span class="source-line-no">166</span><span id="line-166"> *</span>
<span class="source-line-no">167</span><span id="line-167"> * &lt;pre&gt;</span>
<span class="source-line-no">168</span><span id="line-168"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">169</span><span id="line-169"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">170</span><span id="line-170"> * table.get(...);</span>
<span class="source-line-no">171</span><span id="line-171"> * ...</span>
<span class="source-line-no">172</span><span id="line-172"> * }</span>
<span class="source-line-no">173</span><span id="line-173"> * &lt;/pre&gt;</span>
<span class="source-line-no">174</span><span id="line-174"> *</span>
<span class="source-line-no">175</span><span id="line-175"> * @param connectionUri the connection uri for the hbase cluster</span>
<span class="source-line-no">176</span><span id="line-176"> * @param conf configuration</span>
<span class="source-line-no">177</span><span id="line-177"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">178</span><span id="line-178"> */</span>
<span class="source-line-no">179</span><span id="line-179"> public static Connection createConnection(URI connectionUri, Configuration conf)</span>
<span class="source-line-no">180</span><span id="line-180"> throws IOException {</span>
<span class="source-line-no">181</span><span id="line-181"> return createConnection(connectionUri, conf, null, AuthUtil.loginClient(conf));</span>
<span class="source-line-no">182</span><span id="line-182"> }</span>
<span class="source-line-no">183</span><span id="line-183"></span>
<span class="source-line-no">184</span><span id="line-184"> /**</span>
<span class="source-line-no">185</span><span id="line-185"> * Create a new Connection instance using the passed &lt;code&gt;conf&lt;/code&gt; instance. Connection</span>
<span class="source-line-no">186</span><span id="line-186"> * encapsulates all housekeeping for a connection to the cluster. All tables and interfaces</span>
<span class="source-line-no">187</span><span id="line-187"> * created from returned connection share zookeeper connection(if used), meta cache, and</span>
<span class="source-line-no">188</span><span id="line-188"> * connections to region servers and masters. &lt;br&gt;</span>
<span class="source-line-no">189</span><span id="line-189"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">190</span><span id="line-190"> * instance. Typical usage:</span>
<span class="source-line-no">191</span><span id="line-191"> *</span>
<span class="source-line-no">192</span><span id="line-192"> * &lt;pre&gt;</span>
<span class="source-line-no">193</span><span id="line-193"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">194</span><span id="line-194"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">195</span><span id="line-195"> * table.get(...);</span>
<span class="source-line-no">196</span><span id="line-196"> * ...</span>
<span class="source-line-no">197</span><span id="line-197"> * }</span>
<span class="source-line-no">198</span><span id="line-198"> * &lt;/pre&gt;</span>
<span class="source-line-no">199</span><span id="line-199"> *</span>
<span class="source-line-no">200</span><span id="line-200"> * @param conf configuration</span>
<span class="source-line-no">201</span><span id="line-201"> * @param pool the thread pool to use for batch operations</span>
<span class="source-line-no">202</span><span id="line-202"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">203</span><span id="line-203"> */</span>
<span class="source-line-no">204</span><span id="line-204"> public static Connection createConnection(Configuration conf, ExecutorService pool)</span>
<span class="source-line-no">205</span><span id="line-205"> throws IOException {</span>
<span class="source-line-no">206</span><span id="line-206"> return createConnection(conf, pool, AuthUtil.loginClient(conf));</span>
<span class="source-line-no">207</span><span id="line-207"> }</span>
<span class="source-line-no">208</span><span id="line-208"></span>
<span class="source-line-no">209</span><span id="line-209"> /**</span>
<span class="source-line-no">210</span><span id="line-210"> * Create a new Connection instance using the passed &lt;code&gt;conf&lt;/code&gt; instance. Connection</span>
<span class="source-line-no">211</span><span id="line-211"> * encapsulates all housekeeping for a connection to the cluster. All tables and interfaces</span>
<span class="source-line-no">212</span><span id="line-212"> * created from returned connection share zookeeper connection(if used), meta cache, and</span>
<span class="source-line-no">213</span><span id="line-213"> * connections to region servers and masters. &lt;br&gt;</span>
<span class="source-line-no">214</span><span id="line-214"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">215</span><span id="line-215"> * instance. Typical usage:</span>
<span class="source-line-no">216</span><span id="line-216"> *</span>
<span class="source-line-no">217</span><span id="line-217"> * &lt;pre&gt;</span>
<span class="source-line-no">218</span><span id="line-218"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">219</span><span id="line-219"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">220</span><span id="line-220"> * table.get(...);</span>
<span class="source-line-no">221</span><span id="line-221"> * ...</span>
<span class="source-line-no">222</span><span id="line-222"> * }</span>
<span class="source-line-no">223</span><span id="line-223"> * &lt;/pre&gt;</span>
<span class="source-line-no">224</span><span id="line-224"> *</span>
<span class="source-line-no">225</span><span id="line-225"> * @param connectionUri the connection uri for the hbase cluster</span>
<span class="source-line-no">226</span><span id="line-226"> * @param conf configuration</span>
<span class="source-line-no">227</span><span id="line-227"> * @param pool the thread pool to use for batch operations</span>
<span class="source-line-no">228</span><span id="line-228"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">229</span><span id="line-229"> */</span>
<span class="source-line-no">230</span><span id="line-230"> public static Connection createConnection(URI connectionUri, Configuration conf,</span>
<span class="source-line-no">231</span><span id="line-231"> ExecutorService pool) throws IOException {</span>
<span class="source-line-no">232</span><span id="line-232"> return createConnection(connectionUri, conf, pool, AuthUtil.loginClient(conf));</span>
<span class="source-line-no">233</span><span id="line-233"> }</span>
<span class="source-line-no">234</span><span id="line-234"></span>
<span class="source-line-no">235</span><span id="line-235"> /**</span>
<span class="source-line-no">236</span><span id="line-236"> * Create a new Connection instance using the passed &lt;code&gt;conf&lt;/code&gt; instance. Connection</span>
<span class="source-line-no">237</span><span id="line-237"> * encapsulates all housekeeping for a connection to the cluster. All tables and interfaces</span>
<span class="source-line-no">238</span><span id="line-238"> * created from returned connection share zookeeper connection(if used), meta cache, and</span>
<span class="source-line-no">239</span><span id="line-239"> * connections to region servers and masters. &lt;br&gt;</span>
<span class="source-line-no">240</span><span id="line-240"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">241</span><span id="line-241"> * instance. Typical usage:</span>
<span class="source-line-no">242</span><span id="line-242"> *</span>
<span class="source-line-no">243</span><span id="line-243"> * &lt;pre&gt;</span>
<span class="source-line-no">244</span><span id="line-244"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">245</span><span id="line-245"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">246</span><span id="line-246"> * table.get(...);</span>
<span class="source-line-no">247</span><span id="line-247"> * ...</span>
<span class="source-line-no">248</span><span id="line-248"> * }</span>
<span class="source-line-no">249</span><span id="line-249"> * &lt;/pre&gt;</span>
<span class="source-line-no">250</span><span id="line-250"> *</span>
<span class="source-line-no">251</span><span id="line-251"> * @param conf configuration</span>
<span class="source-line-no">252</span><span id="line-252"> * @param user the user the connection is for</span>
<span class="source-line-no">253</span><span id="line-253"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">254</span><span id="line-254"> */</span>
<span class="source-line-no">255</span><span id="line-255"> public static Connection createConnection(Configuration conf, User user) throws IOException {</span>
<span class="source-line-no">256</span><span id="line-256"> return createConnection(conf, null, user);</span>
<span class="source-line-no">257</span><span id="line-257"> }</span>
<span class="source-line-no">258</span><span id="line-258"></span>
<span class="source-line-no">259</span><span id="line-259"> /**</span>
<span class="source-line-no">260</span><span id="line-260"> * Create a new Connection instance using the passed &lt;code&gt;conf&lt;/code&gt; instance. Connection</span>
<span class="source-line-no">261</span><span id="line-261"> * encapsulates all housekeeping for a connection to the cluster. All tables and interfaces</span>
<span class="source-line-no">262</span><span id="line-262"> * created from returned connection share zookeeper connection(if used), meta cache, and</span>
<span class="source-line-no">263</span><span id="line-263"> * connections to region servers and masters. &lt;br&gt;</span>
<span class="source-line-no">264</span><span id="line-264"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">265</span><span id="line-265"> * instance. Typical usage:</span>
<span class="source-line-no">266</span><span id="line-266"> *</span>
<span class="source-line-no">267</span><span id="line-267"> * &lt;pre&gt;</span>
<span class="source-line-no">268</span><span id="line-268"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">269</span><span id="line-269"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">270</span><span id="line-270"> * table.get(...);</span>
<span class="source-line-no">271</span><span id="line-271"> * ...</span>
<span class="source-line-no">272</span><span id="line-272"> * }</span>
<span class="source-line-no">273</span><span id="line-273"> * &lt;/pre&gt;</span>
<span class="source-line-no">274</span><span id="line-274"> *</span>
<span class="source-line-no">275</span><span id="line-275"> * @param connectionUri the connection uri for the hbase cluster</span>
<span class="source-line-no">276</span><span id="line-276"> * @param conf configuration</span>
<span class="source-line-no">277</span><span id="line-277"> * @param user the user the connection is for</span>
<span class="source-line-no">278</span><span id="line-278"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">279</span><span id="line-279"> */</span>
<span class="source-line-no">280</span><span id="line-280"> public static Connection createConnection(URI connectionUri, Configuration conf, User user)</span>
<span class="source-line-no">281</span><span id="line-281"> throws IOException {</span>
<span class="source-line-no">282</span><span id="line-282"> return createConnection(connectionUri, conf, null, user);</span>
<span class="source-line-no">283</span><span id="line-283"> }</span>
<span class="source-line-no">284</span><span id="line-284"></span>
<span class="source-line-no">285</span><span id="line-285"> /**</span>
<span class="source-line-no">286</span><span id="line-286"> * Create a new Connection instance using the passed &lt;code&gt;conf&lt;/code&gt; instance. Connection</span>
<span class="source-line-no">287</span><span id="line-287"> * encapsulates all housekeeping for a connection to the cluster. All tables and interfaces</span>
<span class="source-line-no">288</span><span id="line-288"> * created from returned connection share zookeeper connection(if used), meta cache, and</span>
<span class="source-line-no">289</span><span id="line-289"> * connections to region servers and masters. &lt;br&gt;</span>
<span class="source-line-no">290</span><span id="line-290"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">291</span><span id="line-291"> * instance. Typical usage:</span>
<span class="source-line-no">292</span><span id="line-292"> *</span>
<span class="source-line-no">293</span><span id="line-293"> * &lt;pre&gt;</span>
<span class="source-line-no">294</span><span id="line-294"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">295</span><span id="line-295"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">296</span><span id="line-296"> * table.get(...);</span>
<span class="source-line-no">297</span><span id="line-297"> * ...</span>
<span class="source-line-no">298</span><span id="line-298"> * }</span>
<span class="source-line-no">299</span><span id="line-299"> * &lt;/pre&gt;</span>
<span class="source-line-no">300</span><span id="line-300"> *</span>
<span class="source-line-no">301</span><span id="line-301"> * @param conf configuration</span>
<span class="source-line-no">302</span><span id="line-302"> * @param user the user the connection is for</span>
<span class="source-line-no">303</span><span id="line-303"> * @param pool the thread pool to use for batch operations</span>
<span class="source-line-no">304</span><span id="line-304"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">305</span><span id="line-305"> */</span>
<span class="source-line-no">306</span><span id="line-306"> public static Connection createConnection(Configuration conf, ExecutorService pool,</span>
<span class="source-line-no">307</span><span id="line-307"> final User user) throws IOException {</span>
<span class="source-line-no">308</span><span id="line-308"> return createConnection(conf, pool, user, Collections.emptyMap());</span>
<span class="source-line-no">309</span><span id="line-309"> }</span>
<span class="source-line-no">310</span><span id="line-310"></span>
<span class="source-line-no">311</span><span id="line-311"> /**</span>
<span class="source-line-no">312</span><span id="line-312"> * Create a new Connection instance using the passed &lt;code&gt;conf&lt;/code&gt; instance. Connection</span>
<span class="source-line-no">313</span><span id="line-313"> * encapsulates all housekeeping for a connection to the cluster. All tables and interfaces</span>
<span class="source-line-no">314</span><span id="line-314"> * created from returned connection share zookeeper connection(if used), meta cache, and</span>
<span class="source-line-no">315</span><span id="line-315"> * connections to region servers and masters. &lt;br&gt;</span>
<span class="source-line-no">316</span><span id="line-316"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">317</span><span id="line-317"> * instance. Typical usage:</span>
<span class="source-line-no">318</span><span id="line-318"> *</span>
<span class="source-line-no">319</span><span id="line-319"> * &lt;pre&gt;</span>
<span class="source-line-no">320</span><span id="line-320"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">321</span><span id="line-321"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">322</span><span id="line-322"> * table.get(...);</span>
<span class="source-line-no">323</span><span id="line-323"> * ...</span>
<span class="source-line-no">324</span><span id="line-324"> * }</span>
<span class="source-line-no">325</span><span id="line-325"> * &lt;/pre&gt;</span>
<span class="source-line-no">326</span><span id="line-326"> *</span>
<span class="source-line-no">327</span><span id="line-327"> * @param connectionUri the connection uri for the hbase cluster</span>
<span class="source-line-no">328</span><span id="line-328"> * @param conf configuration</span>
<span class="source-line-no">329</span><span id="line-329"> * @param user the user the connection is for</span>
<span class="source-line-no">330</span><span id="line-330"> * @param pool the thread pool to use for batch operations</span>
<span class="source-line-no">331</span><span id="line-331"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">332</span><span id="line-332"> */</span>
<span class="source-line-no">333</span><span id="line-333"> public static Connection createConnection(URI connectionUri, Configuration conf,</span>
<span class="source-line-no">334</span><span id="line-334"> ExecutorService pool, User user) throws IOException {</span>
<span class="source-line-no">335</span><span id="line-335"> return createConnection(connectionUri, conf, pool, user, Collections.emptyMap());</span>
<span class="source-line-no">336</span><span id="line-336"> }</span>
<span class="source-line-no">337</span><span id="line-337"></span>
<span class="source-line-no">338</span><span id="line-338"> /**</span>
<span class="source-line-no">339</span><span id="line-339"> * Create a new Connection instance using the passed &lt;code&gt;conf&lt;/code&gt; instance. Connection</span>
<span class="source-line-no">340</span><span id="line-340"> * encapsulates all housekeeping for a connection to the cluster. All tables and interfaces</span>
<span class="source-line-no">341</span><span id="line-341"> * created from returned connection share zookeeper connection(if used), meta cache, and</span>
<span class="source-line-no">342</span><span id="line-342"> * connections to region servers and masters. &lt;br&gt;</span>
<span class="source-line-no">343</span><span id="line-343"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">344</span><span id="line-344"> * instance. Typical usage:</span>
<span class="source-line-no">345</span><span id="line-345"> *</span>
<span class="source-line-no">346</span><span id="line-346"> * &lt;pre&gt;</span>
<span class="source-line-no">347</span><span id="line-347"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">348</span><span id="line-348"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">349</span><span id="line-349"> * table.get(...);</span>
<span class="source-line-no">350</span><span id="line-350"> * ...</span>
<span class="source-line-no">351</span><span id="line-351"> * }</span>
<span class="source-line-no">352</span><span id="line-352"> * &lt;/pre&gt;</span>
<span class="source-line-no">353</span><span id="line-353"> *</span>
<span class="source-line-no">354</span><span id="line-354"> * @param conf configuration</span>
<span class="source-line-no">355</span><span id="line-355"> * @param user the user the connection is for</span>
<span class="source-line-no">356</span><span id="line-356"> * @param pool the thread pool to use for batch operations</span>
<span class="source-line-no">357</span><span id="line-357"> * @param connectionAttributes attributes to be sent along to server during connection establish</span>
<span class="source-line-no">358</span><span id="line-358"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">359</span><span id="line-359"> */</span>
<span class="source-line-no">360</span><span id="line-360"> public static Connection createConnection(Configuration conf, ExecutorService pool,</span>
<span class="source-line-no">361</span><span id="line-361"> final User user, Map&lt;String, byte[]&gt; connectionAttributes) throws IOException {</span>
<span class="source-line-no">362</span><span id="line-362"> return createConnection(null, conf, pool, user, connectionAttributes);</span>
<span class="source-line-no">363</span><span id="line-363"> }</span>
<span class="source-line-no">364</span><span id="line-364"></span>
<span class="source-line-no">365</span><span id="line-365"> /**</span>
<span class="source-line-no">366</span><span id="line-366"> * Create a new Connection instance using the passed &lt;code&gt;conf&lt;/code&gt; instance. Connection</span>
<span class="source-line-no">367</span><span id="line-367"> * encapsulates all housekeeping for a connection to the cluster. All tables and interfaces</span>
<span class="source-line-no">368</span><span id="line-368"> * created from returned connection share zookeeper connection(if used), meta cache, and</span>
<span class="source-line-no">369</span><span id="line-369"> * connections to region servers and masters. &lt;br&gt;</span>
<span class="source-line-no">370</span><span id="line-370"> * The caller is responsible for calling {@link Connection#close()} on the returned connection</span>
<span class="source-line-no">371</span><span id="line-371"> * instance. Typical usage:</span>
<span class="source-line-no">372</span><span id="line-372"> *</span>
<span class="source-line-no">373</span><span id="line-373"> * &lt;pre&gt;</span>
<span class="source-line-no">374</span><span id="line-374"> * Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">375</span><span id="line-375"> * Table table = connection.getTable(TableName.valueOf("table1"));</span>
<span class="source-line-no">376</span><span id="line-376"> * try (Connection connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">377</span><span id="line-377"> * Table table = connection.getTable(TableName.valueOf("table1"))) {</span>
<span class="source-line-no">378</span><span id="line-378"> * table.get(...);</span>
<span class="source-line-no">379</span><span id="line-379"> * ...</span>
<span class="source-line-no">380</span><span id="line-380"> * }</span>
<span class="source-line-no">381</span><span id="line-381"> * &lt;/pre&gt;</span>
<span class="source-line-no">382</span><span id="line-382"> *</span>
<span class="source-line-no">383</span><span id="line-383"> * @param connectionUri the connection uri for the hbase cluster</span>
<span class="source-line-no">384</span><span id="line-384"> * @param conf configuration</span>
<span class="source-line-no">385</span><span id="line-385"> * @param user the user the connection is for</span>
<span class="source-line-no">386</span><span id="line-386"> * @param pool the thread pool to use for batch operations</span>
<span class="source-line-no">387</span><span id="line-387"> * @param connectionAttributes attributes to be sent along to server during connection establish</span>
<span class="source-line-no">388</span><span id="line-388"> * @return Connection object for &lt;code&gt;conf&lt;/code&gt;</span>
<span class="source-line-no">389</span><span id="line-389"> */</span>
<span class="source-line-no">390</span><span id="line-390"> public static Connection createConnection(URI connectionUri, Configuration conf,</span>
<span class="source-line-no">391</span><span id="line-391"> ExecutorService pool, final User user, Map&lt;String, byte[]&gt; connectionAttributes)</span>
<span class="source-line-no">392</span><span id="line-392"> throws IOException {</span>
<span class="source-line-no">393</span><span id="line-393"> Class&lt;?&gt; clazz = conf.getClass(ConnectionUtils.HBASE_CLIENT_CONNECTION_IMPL,</span>
<span class="source-line-no">394</span><span id="line-394"> ConnectionOverAsyncConnection.class, Connection.class);</span>
<span class="source-line-no">395</span><span id="line-395"> if (clazz != ConnectionOverAsyncConnection.class) {</span>
<span class="source-line-no">396</span><span id="line-396"> return TraceUtil.trace(() -&gt; {</span>
<span class="source-line-no">397</span><span id="line-397"> try {</span>
<span class="source-line-no">398</span><span id="line-398"> // Default HCM#HCI is not accessible; make it so before invoking.</span>
<span class="source-line-no">399</span><span id="line-399"> Constructor&lt;?&gt; constructor = clazz.getDeclaredConstructor(Configuration.class,</span>
<span class="source-line-no">400</span><span id="line-400"> ExecutorService.class, User.class, ConnectionRegistry.class, Map.class);</span>
<span class="source-line-no">401</span><span id="line-401"> constructor.setAccessible(true);</span>
<span class="source-line-no">402</span><span id="line-402"> ConnectionRegistry registry = connectionUri != null</span>
<span class="source-line-no">403</span><span id="line-403"> ? ConnectionRegistryFactory.create(connectionUri, conf, user)</span>
<span class="source-line-no">404</span><span id="line-404"> : ConnectionRegistryFactory.create(conf, user);</span>
<span class="source-line-no">405</span><span id="line-405"> return user.runAs((PrivilegedExceptionAction&lt;Connection&gt;) () -&gt; (Connection) constructor</span>
<span class="source-line-no">406</span><span id="line-406"> .newInstance(conf, pool, user, registry, connectionAttributes));</span>
<span class="source-line-no">407</span><span id="line-407"> } catch (NoSuchMethodException e) {</span>
<span class="source-line-no">408</span><span id="line-408"> LOG.debug("Constructor with connection registry not found for class {},"</span>
<span class="source-line-no">409</span><span id="line-409"> + " fallback to use old constructor", clazz.getName(), e);</span>
<span class="source-line-no">410</span><span id="line-410"> } catch (Exception e) {</span>
<span class="source-line-no">411</span><span id="line-411"> Throwables.throwIfInstanceOf(e, IOException.class);</span>
<span class="source-line-no">412</span><span id="line-412"> Throwables.throwIfUnchecked(e);</span>
<span class="source-line-no">413</span><span id="line-413"> throw new IOException(e);</span>
<span class="source-line-no">414</span><span id="line-414"> }</span>
<span class="source-line-no">415</span><span id="line-415"></span>
<span class="source-line-no">416</span><span id="line-416"> try {</span>
<span class="source-line-no">417</span><span id="line-417"> // Default HCM#HCI is not accessible; make it so before invoking.</span>
<span class="source-line-no">418</span><span id="line-418"> Constructor&lt;?&gt; constructor = clazz.getDeclaredConstructor(Configuration.class,</span>
<span class="source-line-no">419</span><span id="line-419"> ExecutorService.class, User.class, Map.class);</span>
<span class="source-line-no">420</span><span id="line-420"> constructor.setAccessible(true);</span>
<span class="source-line-no">421</span><span id="line-421"> return user.runAs((PrivilegedExceptionAction&lt;Connection&gt;) () -&gt; (Connection) constructor</span>
<span class="source-line-no">422</span><span id="line-422"> .newInstance(conf, pool, user, connectionAttributes));</span>
<span class="source-line-no">423</span><span id="line-423"> } catch (Exception e) {</span>
<span class="source-line-no">424</span><span id="line-424"> Throwables.throwIfInstanceOf(e, IOException.class);</span>
<span class="source-line-no">425</span><span id="line-425"> Throwables.throwIfUnchecked(e);</span>
<span class="source-line-no">426</span><span id="line-426"> throw new IOException(e);</span>
<span class="source-line-no">427</span><span id="line-427"> }</span>
<span class="source-line-no">428</span><span id="line-428"> }, () -&gt; TraceUtil.createSpan(ConnectionFactory.class.getSimpleName() + ".createConnection"));</span>
<span class="source-line-no">429</span><span id="line-429"> } else {</span>
<span class="source-line-no">430</span><span id="line-430"> return FutureUtils.get(createAsyncConnection(connectionUri, conf, user, connectionAttributes))</span>
<span class="source-line-no">431</span><span id="line-431"> .toConnection();</span>
<span class="source-line-no">432</span><span id="line-432"> }</span>
<span class="source-line-no">433</span><span id="line-433"> }</span>
<span class="source-line-no">434</span><span id="line-434"></span>
<span class="source-line-no">435</span><span id="line-435"> /**</span>
<span class="source-line-no">436</span><span id="line-436"> * Call {@link #createAsyncConnection(Configuration)} using default HBaseConfiguration.</span>
<span class="source-line-no">437</span><span id="line-437"> * @see #createAsyncConnection(Configuration)</span>
<span class="source-line-no">438</span><span id="line-438"> * @return AsyncConnection object wrapped by CompletableFuture</span>
<span class="source-line-no">439</span><span id="line-439"> */</span>
<span class="source-line-no">440</span><span id="line-440"> public static CompletableFuture&lt;AsyncConnection&gt; createAsyncConnection() {</span>
<span class="source-line-no">441</span><span id="line-441"> return createAsyncConnection(HBaseConfiguration.create());</span>
<span class="source-line-no">442</span><span id="line-442"> }</span>
<span class="source-line-no">443</span><span id="line-443"></span>
<span class="source-line-no">444</span><span id="line-444"> /**</span>
<span class="source-line-no">445</span><span id="line-445"> * Call {@link #createAsyncConnection(URI, Configuration)} using default HBaseConfiguration.</span>
<span class="source-line-no">446</span><span id="line-446"> * @param connectionUri the connection uri for the hbase cluster</span>
<span class="source-line-no">447</span><span id="line-447"> * @see #createAsyncConnection(URI, Configuration)</span>
<span class="source-line-no">448</span><span id="line-448"> * @return AsyncConnection object wrapped by CompletableFuture</span>
<span class="source-line-no">449</span><span id="line-449"> */</span>
<span class="source-line-no">450</span><span id="line-450"> public static CompletableFuture&lt;AsyncConnection&gt; createAsyncConnection(URI connectionUri) {</span>
<span class="source-line-no">451</span><span id="line-451"> return createAsyncConnection(connectionUri, HBaseConfiguration.create());</span>
<span class="source-line-no">452</span><span id="line-452"> }</span>
<span class="source-line-no">453</span><span id="line-453"></span>
<span class="source-line-no">454</span><span id="line-454"> /**</span>
<span class="source-line-no">455</span><span id="line-455"> * Call {@link #createAsyncConnection(Configuration, User)} using the given {@code conf} and a</span>
<span class="source-line-no">456</span><span id="line-456"> * User object created by {@link UserProvider}. The given {@code conf} will also be used to</span>
<span class="source-line-no">457</span><span id="line-457"> * initialize the {@link UserProvider}.</span>
<span class="source-line-no">458</span><span id="line-458"> * @param conf configuration</span>
<span class="source-line-no">459</span><span id="line-459"> * @return AsyncConnection object wrapped by CompletableFuture</span>
<span class="source-line-no">460</span><span id="line-460"> * @see #createAsyncConnection(Configuration, User)</span>
<span class="source-line-no">461</span><span id="line-461"> * @see UserProvider</span>
<span class="source-line-no">462</span><span id="line-462"> */</span>
<span class="source-line-no">463</span><span id="line-463"> public static CompletableFuture&lt;AsyncConnection&gt; createAsyncConnection(Configuration conf) {</span>
<span class="source-line-no">464</span><span id="line-464"> return createAsyncConnection(null, conf);</span>
<span class="source-line-no">465</span><span id="line-465"> }</span>
<span class="source-line-no">466</span><span id="line-466"></span>
<span class="source-line-no">467</span><span id="line-467"> /**</span>
<span class="source-line-no">468</span><span id="line-468"> * Call {@link #createAsyncConnection(Configuration, User)} using the given {@code connectionUri},</span>
<span class="source-line-no">469</span><span id="line-469"> * {@code conf} and a User object created by {@link UserProvider}. The given {@code conf} will</span>
<span class="source-line-no">470</span><span id="line-470"> * also be used to initialize the {@link UserProvider}.</span>
<span class="source-line-no">471</span><span id="line-471"> * @param connectionUri the connection uri for the hbase cluster</span>
<span class="source-line-no">472</span><span id="line-472"> * @param conf configuration</span>
<span class="source-line-no">473</span><span id="line-473"> * @return AsyncConnection object wrapped by CompletableFuture</span>
<span class="source-line-no">474</span><span id="line-474"> * @see #createAsyncConnection(Configuration, User)</span>
<span class="source-line-no">475</span><span id="line-475"> * @see UserProvider</span>
<span class="source-line-no">476</span><span id="line-476"> */</span>
<span class="source-line-no">477</span><span id="line-477"> public static CompletableFuture&lt;AsyncConnection&gt; createAsyncConnection(URI connectionUri,</span>
<span class="source-line-no">478</span><span id="line-478"> Configuration conf) {</span>
<span class="source-line-no">479</span><span id="line-479"> User user;</span>
<span class="source-line-no">480</span><span id="line-480"> try {</span>
<span class="source-line-no">481</span><span id="line-481"> user = AuthUtil.loginClient(conf);</span>
<span class="source-line-no">482</span><span id="line-482"> } catch (IOException e) {</span>
<span class="source-line-no">483</span><span id="line-483"> CompletableFuture&lt;AsyncConnection&gt; future = new CompletableFuture&lt;&gt;();</span>
<span class="source-line-no">484</span><span id="line-484"> future.completeExceptionally(e);</span>
<span class="source-line-no">485</span><span id="line-485"> return future;</span>
<span class="source-line-no">486</span><span id="line-486"> }</span>
<span class="source-line-no">487</span><span id="line-487"> return createAsyncConnection(connectionUri, conf, user);</span>
<span class="source-line-no">488</span><span id="line-488"> }</span>
<span class="source-line-no">489</span><span id="line-489"></span>
<span class="source-line-no">490</span><span id="line-490"> /**</span>
<span class="source-line-no">491</span><span id="line-491"> * Create a new AsyncConnection instance using the passed {@code conf} and {@code user}.</span>
<span class="source-line-no">492</span><span id="line-492"> * AsyncConnection encapsulates all housekeeping for a connection to the cluster. All tables and</span>
<span class="source-line-no">493</span><span id="line-493"> * interfaces created from returned connection share zookeeper connection, meta cache, and</span>
<span class="source-line-no">494</span><span id="line-494"> * connections to region servers and masters.</span>
<span class="source-line-no">495</span><span id="line-495"> * &lt;p&gt;</span>
<span class="source-line-no">496</span><span id="line-496"> * The caller is responsible for calling {@link AsyncConnection#close()} on the returned</span>
<span class="source-line-no">497</span><span id="line-497"> * connection instance.</span>
<span class="source-line-no">498</span><span id="line-498"> * &lt;p&gt;</span>
<span class="source-line-no">499</span><span id="line-499"> * Usually you should only create one AsyncConnection instance in your code and use it everywhere</span>
<span class="source-line-no">500</span><span id="line-500"> * as it is thread safe.</span>
<span class="source-line-no">501</span><span id="line-501"> * @param conf configuration</span>
<span class="source-line-no">502</span><span id="line-502"> * @param user the user the asynchronous connection is for</span>
<span class="source-line-no">503</span><span id="line-503"> * @return AsyncConnection object wrapped by CompletableFuture</span>
<span class="source-line-no">504</span><span id="line-504"> */</span>
<span class="source-line-no">505</span><span id="line-505"> public static CompletableFuture&lt;AsyncConnection&gt; createAsyncConnection(Configuration conf,</span>
<span class="source-line-no">506</span><span id="line-506"> final User user) {</span>
<span class="source-line-no">507</span><span id="line-507"> return createAsyncConnection(null, conf, user);</span>
<span class="source-line-no">508</span><span id="line-508"> }</span>
<span class="source-line-no">509</span><span id="line-509"></span>
<span class="source-line-no">510</span><span id="line-510"> /**</span>
<span class="source-line-no">511</span><span id="line-511"> * Create a new AsyncConnection instance using the passed {@code connectionUri}, {@code conf} and</span>
<span class="source-line-no">512</span><span id="line-512"> * {@code user}. AsyncConnection encapsulates all housekeeping for a connection to the cluster.</span>
<span class="source-line-no">513</span><span id="line-513"> * All tables and interfaces created from returned connection share zookeeper connection(if used),</span>
<span class="source-line-no">514</span><span id="line-514"> * meta cache, and connections to region servers and masters.</span>
<span class="source-line-no">515</span><span id="line-515"> * &lt;p&gt;</span>
<span class="source-line-no">516</span><span id="line-516"> * The caller is responsible for calling {@link AsyncConnection#close()} on the returned</span>
<span class="source-line-no">517</span><span id="line-517"> * connection instance.</span>
<span class="source-line-no">518</span><span id="line-518"> * &lt;p&gt;</span>
<span class="source-line-no">519</span><span id="line-519"> * Usually you should only create one AsyncConnection instance in your code and use it everywhere</span>
<span class="source-line-no">520</span><span id="line-520"> * as it is thread safe.</span>
<span class="source-line-no">521</span><span id="line-521"> * @param connectionUri the connection uri for the hbase cluster</span>
<span class="source-line-no">522</span><span id="line-522"> * @param conf configuration</span>
<span class="source-line-no">523</span><span id="line-523"> * @param user the user the asynchronous connection is for</span>
<span class="source-line-no">524</span><span id="line-524"> * @return AsyncConnection object wrapped by CompletableFuture</span>
<span class="source-line-no">525</span><span id="line-525"> */</span>
<span class="source-line-no">526</span><span id="line-526"> public static CompletableFuture&lt;AsyncConnection&gt; createAsyncConnection(URI connectionUri,</span>
<span class="source-line-no">527</span><span id="line-527"> Configuration conf, final User user) {</span>
<span class="source-line-no">528</span><span id="line-528"> return createAsyncConnection(connectionUri, conf, user, null);</span>
<span class="source-line-no">529</span><span id="line-529"> }</span>
<span class="source-line-no">530</span><span id="line-530"></span>
<span class="source-line-no">531</span><span id="line-531"> /**</span>
<span class="source-line-no">532</span><span id="line-532"> * Create a new AsyncConnection instance using the passed {@code conf} and {@code user}.</span>
<span class="source-line-no">533</span><span id="line-533"> * AsyncConnection encapsulates all housekeeping for a connection to the cluster. All tables and</span>
<span class="source-line-no">534</span><span id="line-534"> * interfaces created from returned connection share zookeeper connection, meta cache, and</span>
<span class="source-line-no">535</span><span id="line-535"> * connections to region servers and masters.</span>
<span class="source-line-no">536</span><span id="line-536"> * &lt;p&gt;</span>
<span class="source-line-no">537</span><span id="line-537"> * The caller is responsible for calling {@link AsyncConnection#close()} on the returned</span>
<span class="source-line-no">538</span><span id="line-538"> * connection instance.</span>
<span class="source-line-no">539</span><span id="line-539"> * &lt;p&gt;</span>
<span class="source-line-no">540</span><span id="line-540"> * Usually you should only create one AsyncConnection instance in your code and use it everywhere</span>
<span class="source-line-no">541</span><span id="line-541"> * as it is thread safe.</span>
<span class="source-line-no">542</span><span id="line-542"> * @param conf configuration</span>
<span class="source-line-no">543</span><span id="line-543"> * @param user the user the asynchronous connection is for</span>
<span class="source-line-no">544</span><span id="line-544"> * @param connectionAttributes attributes to be sent along to server during connection establish</span>
<span class="source-line-no">545</span><span id="line-545"> * @return AsyncConnection object wrapped by CompletableFuture</span>
<span class="source-line-no">546</span><span id="line-546"> */</span>
<span class="source-line-no">547</span><span id="line-547"> public static CompletableFuture&lt;AsyncConnection&gt; createAsyncConnection(Configuration conf,</span>
<span class="source-line-no">548</span><span id="line-548"> final User user, Map&lt;String, byte[]&gt; connectionAttributes) {</span>
<span class="source-line-no">549</span><span id="line-549"> return createAsyncConnection(null, conf, user, connectionAttributes);</span>
<span class="source-line-no">550</span><span id="line-550"> }</span>
<span class="source-line-no">551</span><span id="line-551"></span>
<span class="source-line-no">552</span><span id="line-552"> /**</span>
<span class="source-line-no">553</span><span id="line-553"> * Create a new AsyncConnection instance using the passed {@code connectionUri}, {@code conf} and</span>
<span class="source-line-no">554</span><span id="line-554"> * {@code user}. AsyncConnection encapsulates all housekeeping for a connection to the cluster.</span>
<span class="source-line-no">555</span><span id="line-555"> * All tables and interfaces created from returned connection share zookeeper connection(if used),</span>
<span class="source-line-no">556</span><span id="line-556"> * meta cache, and connections to region servers and masters.</span>
<span class="source-line-no">557</span><span id="line-557"> * &lt;p&gt;</span>
<span class="source-line-no">558</span><span id="line-558"> * The caller is responsible for calling {@link AsyncConnection#close()} on the returned</span>
<span class="source-line-no">559</span><span id="line-559"> * connection instance.</span>
<span class="source-line-no">560</span><span id="line-560"> * &lt;p&gt;</span>
<span class="source-line-no">561</span><span id="line-561"> * Usually you should only create one AsyncConnection instance in your code and use it everywhere</span>
<span class="source-line-no">562</span><span id="line-562"> * as it is thread safe.</span>
<span class="source-line-no">563</span><span id="line-563"> * @param connectionUri the connection uri for the hbase cluster</span>
<span class="source-line-no">564</span><span id="line-564"> * @param conf configuration</span>
<span class="source-line-no">565</span><span id="line-565"> * @param user the user the asynchronous connection is for</span>
<span class="source-line-no">566</span><span id="line-566"> * @param connectionAttributes attributes to be sent along to server during connection establish</span>
<span class="source-line-no">567</span><span id="line-567"> * @return AsyncConnection object wrapped by CompletableFuture</span>
<span class="source-line-no">568</span><span id="line-568"> */</span>
<span class="source-line-no">569</span><span id="line-569"> public static CompletableFuture&lt;AsyncConnection&gt; createAsyncConnection(URI connectionUri,</span>
<span class="source-line-no">570</span><span id="line-570"> Configuration conf, final User user, Map&lt;String, byte[]&gt; connectionAttributes) {</span>
<span class="source-line-no">571</span><span id="line-571"> return TraceUtil.tracedFuture(() -&gt; {</span>
<span class="source-line-no">572</span><span id="line-572"> ConnectionRegistry registry;</span>
<span class="source-line-no">573</span><span id="line-573"> Configuration appliedConf;</span>
<span class="source-line-no">574</span><span id="line-574"> try {</span>
<span class="source-line-no">575</span><span id="line-575"> if (connectionUri != null) {</span>
<span class="source-line-no">576</span><span id="line-576"> appliedConf = new Configuration(conf);</span>
<span class="source-line-no">577</span><span id="line-577"> Strings.applyURIQueriesToConf(connectionUri, appliedConf);</span>
<span class="source-line-no">578</span><span id="line-578"> registry = ConnectionRegistryFactory.create(connectionUri, appliedConf, user);</span>
<span class="source-line-no">579</span><span id="line-579"> } else {</span>
<span class="source-line-no">580</span><span id="line-580"> appliedConf = conf;</span>
<span class="source-line-no">581</span><span id="line-581"> registry = ConnectionRegistryFactory.create(appliedConf, user);</span>
<span class="source-line-no">582</span><span id="line-582"> }</span>
<span class="source-line-no">583</span><span id="line-583"> } catch (Exception e) {</span>
<span class="source-line-no">584</span><span id="line-584"> return FutureUtils.failedFuture(e);</span>
<span class="source-line-no">585</span><span id="line-585"> }</span>
<span class="source-line-no">586</span><span id="line-586"> CompletableFuture&lt;AsyncConnection&gt; future = new CompletableFuture&lt;&gt;();</span>
<span class="source-line-no">587</span><span id="line-587"> addListener(registry.getClusterId(), (clusterId, error) -&gt; {</span>
<span class="source-line-no">588</span><span id="line-588"> if (error != null) {</span>
<span class="source-line-no">589</span><span id="line-589"> registry.close();</span>
<span class="source-line-no">590</span><span id="line-590"> future.completeExceptionally(error);</span>
<span class="source-line-no">591</span><span id="line-591"> return;</span>
<span class="source-line-no">592</span><span id="line-592"> }</span>
<span class="source-line-no">593</span><span id="line-593"> if (clusterId == null) {</span>
<span class="source-line-no">594</span><span id="line-594"> registry.close();</span>
<span class="source-line-no">595</span><span id="line-595"> future.completeExceptionally(new IOException("clusterid came back null"));</span>
<span class="source-line-no">596</span><span id="line-596"> return;</span>
<span class="source-line-no">597</span><span id="line-597"> }</span>
<span class="source-line-no">598</span><span id="line-598"> Class&lt;? extends AsyncConnection&gt; clazz = appliedConf.getClass(</span>
<span class="source-line-no">599</span><span id="line-599"> HBASE_CLIENT_ASYNC_CONNECTION_IMPL, AsyncConnectionImpl.class, AsyncConnection.class);</span>
<span class="source-line-no">600</span><span id="line-600"> try {</span>
<span class="source-line-no">601</span><span id="line-601"> future.complete(user.runAs((PrivilegedExceptionAction&lt;</span>
<span class="source-line-no">602</span><span id="line-602"> ? extends AsyncConnection&gt;) () -&gt; ReflectionUtils.newInstance(clazz, appliedConf,</span>
<span class="source-line-no">603</span><span id="line-603"> registry, clusterId, null, user, connectionAttributes)));</span>
<span class="source-line-no">604</span><span id="line-604"> } catch (Exception e) {</span>
<span class="source-line-no">605</span><span id="line-605"> registry.close();</span>
<span class="source-line-no">606</span><span id="line-606"> future.completeExceptionally(e);</span>
<span class="source-line-no">607</span><span id="line-607"> }</span>
<span class="source-line-no">608</span><span id="line-608"> });</span>
<span class="source-line-no">609</span><span id="line-609"> return future;</span>
<span class="source-line-no">610</span><span id="line-610"> }, "ConnectionFactory.createAsyncConnection");</span>
<span class="source-line-no">611</span><span id="line-611"> }</span>
<span class="source-line-no">612</span><span id="line-612">}</span>
</pre>
</div>
</main>
</body>
</html>