| <!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: ConnectionRegistryFactory"> |
| <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.URI;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.net.URISyntaxException;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Locale;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.ServiceLoader;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.commons.lang3.StringUtils;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.security.User;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.util.ReflectionUtils;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.slf4j.Logger;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableMap;</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36">/**</span> |
| <span class="source-line-no">037</span><span id="line-37"> * The entry point for creating a {@link ConnectionRegistry}.</span> |
| <span class="source-line-no">038</span><span id="line-38"> */</span> |
| <span class="source-line-no">039</span><span id="line-39">@InterfaceAudience.Private</span> |
| <span class="source-line-no">040</span><span id="line-40">public final class ConnectionRegistryFactory {</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 final Logger LOG = LoggerFactory.getLogger(ConnectionRegistryFactory.class);</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> private static final ImmutableMap<String, ConnectionRegistryURIFactory> FACTORIES;</span> |
| <span class="source-line-no">045</span><span id="line-45"> static {</span> |
| <span class="source-line-no">046</span><span id="line-46"> ImmutableMap.Builder<String, ConnectionRegistryURIFactory> builder = ImmutableMap.builder();</span> |
| <span class="source-line-no">047</span><span id="line-47"> for (ConnectionRegistryURIFactory factory : ServiceLoader</span> |
| <span class="source-line-no">048</span><span id="line-48"> .load(ConnectionRegistryURIFactory.class)) {</span> |
| <span class="source-line-no">049</span><span id="line-49"> builder.put(factory.getScheme().toLowerCase(), factory);</span> |
| <span class="source-line-no">050</span><span id="line-50"> }</span> |
| <span class="source-line-no">051</span><span id="line-51"> // throw IllegalArgumentException if there are duplicated keys</span> |
| <span class="source-line-no">052</span><span id="line-52"> FACTORIES = builder.buildOrThrow();</span> |
| <span class="source-line-no">053</span><span id="line-53"> }</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> private ConnectionRegistryFactory() {</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"> /**</span> |
| <span class="source-line-no">059</span><span id="line-59"> * Returns the connection registry implementation to use, for the given connection url</span> |
| <span class="source-line-no">060</span><span id="line-60"> * {@code uri}.</span> |
| <span class="source-line-no">061</span><span id="line-61"> * <p/></span> |
| <span class="source-line-no">062</span><span id="line-62"> * We use {@link ServiceLoader} to load different implementations, and use the scheme of the given</span> |
| <span class="source-line-no">063</span><span id="line-63"> * {@code uri} to select. And if there is no protocol specified, or we can not find a</span> |
| <span class="source-line-no">064</span><span id="line-64"> * {@link ConnectionRegistryURIFactory} implementation for the given scheme, we will fallback to</span> |
| <span class="source-line-no">065</span><span id="line-65"> * use the old way to create the {@link ConnectionRegistry}. Notice that, if fallback happens, the</span> |
| <span class="source-line-no">066</span><span id="line-66"> * specified connection url {@code uri} will not take effect, we will load all the related</span> |
| <span class="source-line-no">067</span><span id="line-67"> * configurations from the given Configuration instance {@code conf}</span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69"> static ConnectionRegistry create(URI uri, Configuration conf, User user) throws IOException {</span> |
| <span class="source-line-no">070</span><span id="line-70"> if (StringUtils.isBlank(uri.getScheme())) {</span> |
| <span class="source-line-no">071</span><span id="line-71"> LOG.warn("No scheme specified for {}, fallback to use old way", uri);</span> |
| <span class="source-line-no">072</span><span id="line-72"> return create(conf, user);</span> |
| <span class="source-line-no">073</span><span id="line-73"> }</span> |
| <span class="source-line-no">074</span><span id="line-74"> ConnectionRegistryURIFactory factory = FACTORIES.get(uri.getScheme().toLowerCase());</span> |
| <span class="source-line-no">075</span><span id="line-75"> if (factory == null) {</span> |
| <span class="source-line-no">076</span><span id="line-76"> LOG.warn("No factory registered for {}, fallback to use old way", uri);</span> |
| <span class="source-line-no">077</span><span id="line-77"> return create(conf, user);</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"> return factory.create(uri, conf, user);</span> |
| <span class="source-line-no">080</span><span id="line-80"> }</span> |
| <span class="source-line-no">081</span><span id="line-81"></span> |
| <span class="source-line-no">082</span><span id="line-82"> /**</span> |
| <span class="source-line-no">083</span><span id="line-83"> * Returns the connection registry implementation to use.</span> |
| <span class="source-line-no">084</span><span id="line-84"> * <p/></span> |
| <span class="source-line-no">085</span><span id="line-85"> * This is used when we do not have a connection url, we will use the old way to load the</span> |
| <span class="source-line-no">086</span><span id="line-86"> * connection registry, by checking the</span> |
| <span class="source-line-no">087</span><span id="line-87"> * {@literal HConstants#CLIENT_CONNECTION_REGISTRY_IMPL_CONF_KEY} configuration.</span> |
| <span class="source-line-no">088</span><span id="line-88"> */</span> |
| <span class="source-line-no">089</span><span id="line-89"> static ConnectionRegistry create(Configuration conf, User user) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> Class<? extends ConnectionRegistry> clazz =</span> |
| <span class="source-line-no">091</span><span id="line-91"> conf.getClass(HConstants.CLIENT_CONNECTION_REGISTRY_IMPL_CONF_KEY,</span> |
| <span class="source-line-no">092</span><span id="line-92"> RpcConnectionRegistry.class, ConnectionRegistry.class);</span> |
| <span class="source-line-no">093</span><span id="line-93"> return ReflectionUtils.newInstance(clazz, conf, user);</span> |
| <span class="source-line-no">094</span><span id="line-94"> }</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> |
| <span class="source-line-no">097</span><span id="line-97"> * Check whether the given {@code uri} is valid.</span> |
| <span class="source-line-no">098</span><span id="line-98"> * <p/></span> |
| <span class="source-line-no">099</span><span id="line-99"> * Notice that there is no fallback logic for this method, so passing an URI with null scheme can</span> |
| <span class="source-line-no">100</span><span id="line-100"> * not pass.</span> |
| <span class="source-line-no">101</span><span id="line-101"> * @throws IOException if this is not a valid connection registry URI</span> |
| <span class="source-line-no">102</span><span id="line-102"> */</span> |
| <span class="source-line-no">103</span><span id="line-103"> public static void validate(URI uri) throws IOException {</span> |
| <span class="source-line-no">104</span><span id="line-104"> if (StringUtils.isBlank(uri.getScheme())) {</span> |
| <span class="source-line-no">105</span><span id="line-105"> throw new IOException("No schema for uri: " + uri);</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"> ConnectionRegistryURIFactory factory = FACTORIES.get(uri.getScheme().toLowerCase(Locale.ROOT));</span> |
| <span class="source-line-no">108</span><span id="line-108"> if (factory == null) {</span> |
| <span class="source-line-no">109</span><span id="line-109"> throw new IOException(</span> |
| <span class="source-line-no">110</span><span id="line-110"> "No factory registered for scheme " + uri.getScheme() + ", uri: " + uri);</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</span> |
| <span class="source-line-no">112</span><span id="line-112"> factory.validate(uri);</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> /**</span> |
| <span class="source-line-no">116</span><span id="line-116"> * If the given {@code clusterKey} can be parsed to a {@link URI}, and the scheme of the</span> |
| <span class="source-line-no">117</span><span id="line-117"> * {@link URI} is supported by us, return the {@link URI}, otherwise return {@code null}.</span> |
| <span class="source-line-no">118</span><span id="line-118"> * @param clusterKey the cluster key, typically from replication peer config</span> |
| <span class="source-line-no">119</span><span id="line-119"> * @return a {@link URI} or {@code null}.</span> |
| <span class="source-line-no">120</span><span id="line-120"> */</span> |
| <span class="source-line-no">121</span><span id="line-121"> public static URI tryParseAsConnectionURI(String clusterKey) {</span> |
| <span class="source-line-no">122</span><span id="line-122"> // The old cluster key format may not be parsed as URI if we use ip address as the zookeeper</span> |
| <span class="source-line-no">123</span><span id="line-123"> // address, so here we need to catch the URISyntaxException and return false</span> |
| <span class="source-line-no">124</span><span id="line-124"> URI uri;</span> |
| <span class="source-line-no">125</span><span id="line-125"> try {</span> |
| <span class="source-line-no">126</span><span id="line-126"> uri = new URI(clusterKey);</span> |
| <span class="source-line-no">127</span><span id="line-127"> } catch (URISyntaxException e) {</span> |
| <span class="source-line-no">128</span><span id="line-128"> LOG.debug("failed to parse cluster key to URI: {}", clusterKey, e);</span> |
| <span class="source-line-no">129</span><span id="line-129"> return null;</span> |
| <span class="source-line-no">130</span><span id="line-130"> }</span> |
| <span class="source-line-no">131</span><span id="line-131"> if (FACTORIES.containsKey(uri.getScheme())) {</span> |
| <span class="source-line-no">132</span><span id="line-132"> return uri;</span> |
| <span class="source-line-no">133</span><span id="line-133"> } else {</span> |
| <span class="source-line-no">134</span><span id="line-134"> return null;</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">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
