Google Git
Sign in
apache / hbase-site / edc9f41ac5957af2e574b6068b2bdf77baaf06cd / . / devapidocs / src-html / org / apache / hadoop / hbase / client / ConnectionRegistryFactory.html
blob: 990adced43c73ace4e4af7e87c69211d1901f618 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.net.URI;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.URISyntaxException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Locale;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.ServiceLoader;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.commons.lang3.StringUtils;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.conf.Configuration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.HConstants;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.security.User;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.util.ReflectionUtils;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.slf4j.Logger;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.slf4j.LoggerFactory;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableMap;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * The entry point for creating a {@link ConnectionRegistry}.<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>@InterfaceAudience.Private<a name="line.39"></a>
<span class="sourceLineNo">040</span>public final class ConnectionRegistryFactory {<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private static final Logger LOG = LoggerFactory.getLogger(ConnectionRegistryFactory.class);<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> private static final ImmutableMap&lt;String, ConnectionRegistryURIFactory&gt; FACTORIES;<a name="line.44"></a>
<span class="sourceLineNo">045</span> static {<a name="line.45"></a>
<span class="sourceLineNo">046</span> ImmutableMap.Builder&lt;String, ConnectionRegistryURIFactory&gt; builder = ImmutableMap.builder();<a name="line.46"></a>
<span class="sourceLineNo">047</span> for (ConnectionRegistryURIFactory factory : ServiceLoader<a name="line.47"></a>
<span class="sourceLineNo">048</span> .load(ConnectionRegistryURIFactory.class)) {<a name="line.48"></a>
<span class="sourceLineNo">049</span> builder.put(factory.getScheme().toLowerCase(), factory);<a name="line.49"></a>
<span class="sourceLineNo">050</span> }<a name="line.50"></a>
<span class="sourceLineNo">051</span> // throw IllegalArgumentException if there are duplicated keys<a name="line.51"></a>
<span class="sourceLineNo">052</span> FACTORIES = builder.buildOrThrow();<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> private ConnectionRegistryFactory() {<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> /**<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Returns the connection registry implementation to use, for the given connection url<a name="line.59"></a>
<span class="sourceLineNo">060</span> * {@code uri}.<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;p/&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span> * We use {@link ServiceLoader} to load different implementations, and use the scheme of the given<a name="line.62"></a>
<span class="sourceLineNo">063</span> * {@code uri} to select. And if there is no protocol specified, or we can not find a<a name="line.63"></a>
<span class="sourceLineNo">064</span> * {@link ConnectionRegistryURIFactory} implementation for the given scheme, we will fallback to<a name="line.64"></a>
<span class="sourceLineNo">065</span> * use the old way to create the {@link ConnectionRegistry}. Notice that, if fallback happens, the<a name="line.65"></a>
<span class="sourceLineNo">066</span> * specified connection url {@code uri} will not take effect, we will load all the related<a name="line.66"></a>
<span class="sourceLineNo">067</span> * configurations from the given Configuration instance {@code conf}<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> static ConnectionRegistry create(URI uri, Configuration conf, User user) throws IOException {<a name="line.69"></a>
<span class="sourceLineNo">070</span> if (StringUtils.isBlank(uri.getScheme())) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> LOG.warn("No scheme specified for {}, fallback to use old way", uri);<a name="line.71"></a>
<span class="sourceLineNo">072</span> return create(conf, user);<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> ConnectionRegistryURIFactory factory = FACTORIES.get(uri.getScheme().toLowerCase());<a name="line.74"></a>
<span class="sourceLineNo">075</span> if (factory == null) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> LOG.warn("No factory registered for {}, fallback to use old way", uri);<a name="line.76"></a>
<span class="sourceLineNo">077</span> return create(conf, user);<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span> return factory.create(uri, conf, user);<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> /**<a name="line.82"></a>
<span class="sourceLineNo">083</span> * Returns the connection registry implementation to use.<a name="line.83"></a>
<span class="sourceLineNo">084</span> * &lt;p/&gt;<a name="line.84"></a>
<span class="sourceLineNo">085</span> * This is used when we do not have a connection url, we will use the old way to load the<a name="line.85"></a>
<span class="sourceLineNo">086</span> * connection registry, by checking the<a name="line.86"></a>
<span class="sourceLineNo">087</span> * {@literal HConstants#CLIENT_CONNECTION_REGISTRY_IMPL_CONF_KEY} configuration.<a name="line.87"></a>
<span class="sourceLineNo">088</span> */<a name="line.88"></a>
<span class="sourceLineNo">089</span> static ConnectionRegistry create(Configuration conf, User user) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> Class&lt;? extends ConnectionRegistry&gt; clazz =<a name="line.90"></a>
<span class="sourceLineNo">091</span> conf.getClass(HConstants.CLIENT_CONNECTION_REGISTRY_IMPL_CONF_KEY,<a name="line.91"></a>
<span class="sourceLineNo">092</span> RpcConnectionRegistry.class, ConnectionRegistry.class);<a name="line.92"></a>
<span class="sourceLineNo">093</span> return ReflectionUtils.newInstance(clazz, conf, user);<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Check whether the given {@code uri} is valid.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * &lt;p/&gt;<a name="line.98"></a>
<span class="sourceLineNo">099</span> * Notice that there is no fallback logic for this method, so passing an URI with null scheme can<a name="line.99"></a>
<span class="sourceLineNo">100</span> * not pass.<a name="line.100"></a>
<span class="sourceLineNo">101</span> * @throws IOException if this is not a valid connection registry URI<a name="line.101"></a>
<span class="sourceLineNo">102</span> */<a name="line.102"></a>
<span class="sourceLineNo">103</span> public static void validate(URI uri) throws IOException {<a name="line.103"></a>
<span class="sourceLineNo">104</span> if (StringUtils.isBlank(uri.getScheme())) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> throw new IOException("No schema for uri: " + uri);<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span> ConnectionRegistryURIFactory factory = FACTORIES.get(uri.getScheme().toLowerCase(Locale.ROOT));<a name="line.107"></a>
<span class="sourceLineNo">108</span> if (factory == null) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> throw new IOException(<a name="line.109"></a>
<span class="sourceLineNo">110</span> "No factory registered for scheme " + uri.getScheme() + ", uri: " + uri);<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span> factory.validate(uri);<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> /**<a name="line.115"></a>
<span class="sourceLineNo">116</span> * If the given {@code clusterKey} can be parsed to a {@link URI}, and the scheme of the<a name="line.116"></a>
<span class="sourceLineNo">117</span> * {@link URI} is supported by us, return the {@link URI}, otherwise return {@code null}.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @param clusterKey the cluster key, typically from replication peer config<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @return a {@link URI} or {@code null}.<a name="line.119"></a>
<span class="sourceLineNo">120</span> */<a name="line.120"></a>
<span class="sourceLineNo">121</span> public static URI tryParseAsConnectionURI(String clusterKey) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> // The old cluster key format may not be parsed as URI if we use ip address as the zookeeper<a name="line.122"></a>
<span class="sourceLineNo">123</span> // address, so here we need to catch the URISyntaxException and return false<a name="line.123"></a>
<span class="sourceLineNo">124</span> URI uri;<a name="line.124"></a>
<span class="sourceLineNo">125</span> try {<a name="line.125"></a>
<span class="sourceLineNo">126</span> uri = new URI(clusterKey);<a name="line.126"></a>
<span class="sourceLineNo">127</span> } catch (URISyntaxException e) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> LOG.debug("failed to parse cluster key to URI: {}", clusterKey, e);<a name="line.128"></a>
<span class="sourceLineNo">129</span> return null;<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span> if (FACTORIES.containsKey(uri.getScheme())) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> return uri;<a name="line.132"></a>
<span class="sourceLineNo">133</span> } else {<a name="line.133"></a>
<span class="sourceLineNo">134</span> return null;<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span>}<a name="line.137"></a>
</pre>
</div>
</body>
</html>