blob: 88f95bedc6e47bc99f3f8d858f79afd73a9cf1f4 [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: ClusterConnectionFactory">
<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 java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.net.SocketAddress;</span>
<span class="source-line-no">022</span><span id="line-22">import java.net.URI;</span>
<span class="source-line-no">023</span><span id="line-23">import java.security.PrivilegedExceptionAction;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.security.User;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.util.FutureUtils;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.util.ReflectionUtils;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30">/**</span>
<span class="source-line-no">031</span><span id="line-31"> * The factory for creating {@link AsyncClusterConnection}.</span>
<span class="source-line-no">032</span><span id="line-32"> */</span>
<span class="source-line-no">033</span><span id="line-33">@InterfaceAudience.Private</span>
<span class="source-line-no">034</span><span id="line-34">public final class ClusterConnectionFactory {</span>
<span class="source-line-no">035</span><span id="line-35"></span>
<span class="source-line-no">036</span><span id="line-36"> public static final String HBASE_SERVER_CLUSTER_CONNECTION_IMPL =</span>
<span class="source-line-no">037</span><span id="line-37"> "hbase.server.cluster.connection.impl";</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> private ClusterConnectionFactory() {</span>
<span class="source-line-no">040</span><span id="line-40"> }</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42"> private static AsyncClusterConnection createAsyncClusterConnection(Configuration conf,</span>
<span class="source-line-no">043</span><span id="line-43"> ConnectionRegistry registry, SocketAddress localAddress, User user) throws IOException {</span>
<span class="source-line-no">044</span><span id="line-44"> String clusterId = FutureUtils.get(registry.getClusterId());</span>
<span class="source-line-no">045</span><span id="line-45"> Class&lt;? extends AsyncClusterConnection&gt; clazz =</span>
<span class="source-line-no">046</span><span id="line-46"> conf.getClass(HBASE_SERVER_CLUSTER_CONNECTION_IMPL, AsyncClusterConnectionImpl.class,</span>
<span class="source-line-no">047</span><span id="line-47"> AsyncClusterConnection.class);</span>
<span class="source-line-no">048</span><span id="line-48"> try {</span>
<span class="source-line-no">049</span><span id="line-49"> return user</span>
<span class="source-line-no">050</span><span id="line-50"> .runAs((PrivilegedExceptionAction&lt;? extends AsyncClusterConnection&gt;) () -&gt; ReflectionUtils</span>
<span class="source-line-no">051</span><span id="line-51"> .newInstance(clazz, conf, registry, clusterId, localAddress, user));</span>
<span class="source-line-no">052</span><span id="line-52"> } catch (Exception e) {</span>
<span class="source-line-no">053</span><span id="line-53"> throw new IOException(e);</span>
<span class="source-line-no">054</span><span id="line-54"> }</span>
<span class="source-line-no">055</span><span id="line-55"> }</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> /**</span>
<span class="source-line-no">058</span><span id="line-58"> * Create a new {@link AsyncClusterConnection} instance.</span>
<span class="source-line-no">059</span><span id="line-59"> * &lt;p/&gt;</span>
<span class="source-line-no">060</span><span id="line-60"> * Unlike what we have done in {@link ConnectionFactory}, here we just return an</span>
<span class="source-line-no">061</span><span id="line-61"> * {@link AsyncClusterConnection} instead of a {@link java.util.concurrent.CompletableFuture},</span>
<span class="source-line-no">062</span><span id="line-62"> * which means this method could block on fetching the cluster id. This is just used to simplify</span>
<span class="source-line-no">063</span><span id="line-63"> * the implementation, as when starting new region servers, we do not need to be event-driven. Can</span>
<span class="source-line-no">064</span><span id="line-64"> * change later if we want a {@link java.util.concurrent.CompletableFuture} here.</span>
<span class="source-line-no">065</span><span id="line-65"> */</span>
<span class="source-line-no">066</span><span id="line-66"> public static AsyncClusterConnection createAsyncClusterConnection(Configuration conf,</span>
<span class="source-line-no">067</span><span id="line-67"> SocketAddress localAddress, User user) throws IOException {</span>
<span class="source-line-no">068</span><span id="line-68"> return createAsyncClusterConnection(conf, ConnectionRegistryFactory.create(conf, user),</span>
<span class="source-line-no">069</span><span id="line-69"> localAddress, user);</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> /**</span>
<span class="source-line-no">073</span><span id="line-73"> * Create a new {@link AsyncClusterConnection} instance.</span>
<span class="source-line-no">074</span><span id="line-74"> * &lt;p/&gt;</span>
<span class="source-line-no">075</span><span id="line-75"> * This is usually used in replication, the given {@code uri} specifies the connection info of the</span>
<span class="source-line-no">076</span><span id="line-76"> * remote cluster.</span>
<span class="source-line-no">077</span><span id="line-77"> */</span>
<span class="source-line-no">078</span><span id="line-78"> public static AsyncClusterConnection createAsyncClusterConnection(URI uri, Configuration conf,</span>
<span class="source-line-no">079</span><span id="line-79"> SocketAddress localAddress, User user) throws IOException {</span>
<span class="source-line-no">080</span><span id="line-80"> ConnectionRegistry registry = uri != null</span>
<span class="source-line-no">081</span><span id="line-81"> ? ConnectionRegistryFactory.create(uri, conf, user)</span>
<span class="source-line-no">082</span><span id="line-82"> : ConnectionRegistryFactory.create(conf, user);</span>
<span class="source-line-no">083</span><span id="line-83"> return createAsyncClusterConnection(conf, registry, localAddress, user);</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> /**</span>
<span class="source-line-no">087</span><span id="line-87"> * Create a new {@link AsyncClusterConnection} instance to be used at server side where we have a</span>
<span class="source-line-no">088</span><span id="line-88"> * {@link ConnectionRegistryEndpoint}.</span>
<span class="source-line-no">089</span><span id="line-89"> */</span>
<span class="source-line-no">090</span><span id="line-90"> public static AsyncClusterConnection createAsyncClusterConnection(</span>
<span class="source-line-no">091</span><span id="line-91"> ConnectionRegistryEndpoint endpoint, Configuration conf, SocketAddress localAddress, User user)</span>
<span class="source-line-no">092</span><span id="line-92"> throws IOException {</span>
<span class="source-line-no">093</span><span id="line-93"> ShortCircuitConnectionRegistry registry = new ShortCircuitConnectionRegistry(endpoint);</span>
<span class="source-line-no">094</span><span id="line-94"> return createAsyncClusterConnection(conf, registry, localAddress, user);</span>
<span class="source-line-no">095</span><span id="line-95"> }</span>
<span class="source-line-no">096</span><span id="line-96">}</span>
</pre>
</div>
</main>
</body>
</html>