Google Git
Sign in
apache / hbase-site / 6be7f1c569b0f0f64151e4687d98bbf050cb369a / . / devapidocs / src-html / org / apache / hadoop / hbase / util / ConnectionCache.ConnectionInfo.html
blob: 9d87012590817202df252746da155f09a2d518a8 [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.util;<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.util.Map;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.locks.Lock;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.conf.Configuration;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.ChoreService;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.ScheduledChore;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.Stoppable;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.TableName;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.client.Admin;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.client.ConnectionFactory;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.RegionLocator;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.Table;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.security.User;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.security.UserProvider;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.slf4j.Logger;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.slf4j.LoggerFactory;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>/**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * A utility to store user specific HConnections in memory. There is a chore to clean up connections<a name="line.42"></a>
<span class="sourceLineNo">043</span> * idle for too long. This class is used by REST server and Thrift server to support authentication<a name="line.43"></a>
<span class="sourceLineNo">044</span> * and impersonation.<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span>@InterfaceAudience.Private<a name="line.46"></a>
<span class="sourceLineNo">047</span>public class ConnectionCache {<a name="line.47"></a>
<span class="sourceLineNo">048</span> private static final Logger LOG = LoggerFactory.getLogger(ConnectionCache.class);<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> private final Map&lt;String, ConnectionInfo&gt; connections = new ConcurrentHashMap&lt;&gt;();<a name="line.50"></a>
<span class="sourceLineNo">051</span> private final KeyLocker&lt;String&gt; locker = new KeyLocker&lt;&gt;();<a name="line.51"></a>
<span class="sourceLineNo">052</span> private final String realUserName;<a name="line.52"></a>
<span class="sourceLineNo">053</span> private final UserGroupInformation realUser;<a name="line.53"></a>
<span class="sourceLineNo">054</span> private final UserProvider userProvider;<a name="line.54"></a>
<span class="sourceLineNo">055</span> private final Configuration conf;<a name="line.55"></a>
<span class="sourceLineNo">056</span> private final ChoreService choreService;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> private final ThreadLocal&lt;String&gt; effectiveUserNames = new ThreadLocal&lt;String&gt;() {<a name="line.58"></a>
<span class="sourceLineNo">059</span> @Override<a name="line.59"></a>
<span class="sourceLineNo">060</span> protected String initialValue() {<a name="line.60"></a>
<span class="sourceLineNo">061</span> return realUserName;<a name="line.61"></a>
<span class="sourceLineNo">062</span> }<a name="line.62"></a>
<span class="sourceLineNo">063</span> };<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> public ConnectionCache(final Configuration conf, final UserProvider userProvider,<a name="line.65"></a>
<span class="sourceLineNo">066</span> final int cleanInterval, final int maxIdleTime) throws IOException {<a name="line.66"></a>
<span class="sourceLineNo">067</span> Stoppable stoppable = new Stoppable() {<a name="line.67"></a>
<span class="sourceLineNo">068</span> private volatile boolean isStopped = false;<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> @Override<a name="line.70"></a>
<span class="sourceLineNo">071</span> public void stop(String why) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> isStopped = true;<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> @Override<a name="line.75"></a>
<span class="sourceLineNo">076</span> public boolean isStopped() {<a name="line.76"></a>
<span class="sourceLineNo">077</span> return isStopped;<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span> };<a name="line.79"></a>
<span class="sourceLineNo">080</span> this.choreService = new ChoreService("ConnectionCache");<a name="line.80"></a>
<span class="sourceLineNo">081</span> ScheduledChore cleaner = new ScheduledChore("ConnectionCleaner", stoppable, cleanInterval) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> @Override<a name="line.82"></a>
<span class="sourceLineNo">083</span> protected void chore() {<a name="line.83"></a>
<span class="sourceLineNo">084</span> for (Map.Entry&lt;String, ConnectionInfo&gt; entry : connections.entrySet()) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> ConnectionInfo connInfo = entry.getValue();<a name="line.85"></a>
<span class="sourceLineNo">086</span> if (connInfo.timedOut(maxIdleTime)) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> if (connInfo.admin != null) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> try {<a name="line.88"></a>
<span class="sourceLineNo">089</span> connInfo.admin.close();<a name="line.89"></a>
<span class="sourceLineNo">090</span> } catch (Throwable t) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> LOG.info("Got exception in closing idle admin", t);<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span> try {<a name="line.94"></a>
<span class="sourceLineNo">095</span> connInfo.connection.close();<a name="line.95"></a>
<span class="sourceLineNo">096</span> } catch (Throwable t) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> LOG.info("Got exception in closing idle connection", t);<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span> };<a name="line.102"></a>
<span class="sourceLineNo">103</span> // Start the daemon cleaner chore<a name="line.103"></a>
<span class="sourceLineNo">104</span> choreService.scheduleChore(cleaner);<a name="line.104"></a>
<span class="sourceLineNo">105</span> this.realUser = userProvider.getCurrent().getUGI();<a name="line.105"></a>
<span class="sourceLineNo">106</span> this.realUserName = realUser.getShortUserName();<a name="line.106"></a>
<span class="sourceLineNo">107</span> this.userProvider = userProvider;<a name="line.107"></a>
<span class="sourceLineNo">108</span> this.conf = conf;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> /**<a name="line.111"></a>
<span class="sourceLineNo">112</span> * Set the current thread local effective user<a name="line.112"></a>
<span class="sourceLineNo">113</span> */<a name="line.113"></a>
<span class="sourceLineNo">114</span> public void setEffectiveUser(String user) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> effectiveUserNames.set(user);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> /**<a name="line.118"></a>
<span class="sourceLineNo">119</span> * Get the current thread local effective user<a name="line.119"></a>
<span class="sourceLineNo">120</span> */<a name="line.120"></a>
<span class="sourceLineNo">121</span> public String getEffectiveUser() {<a name="line.121"></a>
<span class="sourceLineNo">122</span> return effectiveUserNames.get();<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
<span class="sourceLineNo">126</span> * Called when cache is no longer needed so that it can perform cleanup operations<a name="line.126"></a>
<span class="sourceLineNo">127</span> */<a name="line.127"></a>
<span class="sourceLineNo">128</span> public void shutdown() {<a name="line.128"></a>
<span class="sourceLineNo">129</span> if (choreService != null) choreService.shutdown();<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> /**<a name="line.132"></a>
<span class="sourceLineNo">133</span> * Caller doesn't close the admin afterwards. We need to manage it and close it properly.<a name="line.133"></a>
<span class="sourceLineNo">134</span> */<a name="line.134"></a>
<span class="sourceLineNo">135</span> public Admin getAdmin() throws IOException {<a name="line.135"></a>
<span class="sourceLineNo">136</span> ConnectionInfo connInfo = getCurrentConnection();<a name="line.136"></a>
<span class="sourceLineNo">137</span> if (connInfo.admin == null) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> Lock lock = locker.acquireLock(getEffectiveUser());<a name="line.138"></a>
<span class="sourceLineNo">139</span> try {<a name="line.139"></a>
<span class="sourceLineNo">140</span> if (connInfo.admin == null) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> connInfo.admin = connInfo.connection.getAdmin();<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span> } finally {<a name="line.143"></a>
<span class="sourceLineNo">144</span> lock.unlock();<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> return connInfo.admin;<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> /**<a name="line.150"></a>
<span class="sourceLineNo">151</span> * Caller closes the table afterwards.<a name="line.151"></a>
<span class="sourceLineNo">152</span> */<a name="line.152"></a>
<span class="sourceLineNo">153</span> public Table getTable(String tableName) throws IOException {<a name="line.153"></a>
<span class="sourceLineNo">154</span> ConnectionInfo connInfo = getCurrentConnection();<a name="line.154"></a>
<span class="sourceLineNo">155</span> return connInfo.connection.getTable(TableName.valueOf(tableName));<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> /**<a name="line.158"></a>
<span class="sourceLineNo">159</span> * Retrieve a regionLocator for the table. The user should close the RegionLocator.<a name="line.159"></a>
<span class="sourceLineNo">160</span> */<a name="line.160"></a>
<span class="sourceLineNo">161</span> public RegionLocator getRegionLocator(byte[] tableName) throws IOException {<a name="line.161"></a>
<span class="sourceLineNo">162</span> return getCurrentConnection().connection.getRegionLocator(TableName.valueOf(tableName));<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> /**<a name="line.165"></a>
<span class="sourceLineNo">166</span> * Get the cached connection for the current user. If none or timed out, create a new one.<a name="line.166"></a>
<span class="sourceLineNo">167</span> */<a name="line.167"></a>
<span class="sourceLineNo">168</span> ConnectionInfo getCurrentConnection() throws IOException {<a name="line.168"></a>
<span class="sourceLineNo">169</span> String userName = getEffectiveUser();<a name="line.169"></a>
<span class="sourceLineNo">170</span> ConnectionInfo connInfo = connections.get(userName);<a name="line.170"></a>
<span class="sourceLineNo">171</span> if (connInfo == null || !connInfo.updateAccessTime()) {<a name="line.171"></a>
<span class="sourceLineNo">172</span> Lock lock = locker.acquireLock(userName);<a name="line.172"></a>
<span class="sourceLineNo">173</span> try {<a name="line.173"></a>
<span class="sourceLineNo">174</span> connInfo = connections.get(userName);<a name="line.174"></a>
<span class="sourceLineNo">175</span> if (connInfo == null) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> UserGroupInformation ugi = realUser;<a name="line.176"></a>
<span class="sourceLineNo">177</span> if (!userName.equals(realUserName)) {<a name="line.177"></a>
<span class="sourceLineNo">178</span> ugi = UserGroupInformation.createProxyUser(userName, realUser);<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span> User user = userProvider.create(ugi);<a name="line.180"></a>
<span class="sourceLineNo">181</span> Connection conn = ConnectionFactory.createConnection(conf, user);<a name="line.181"></a>
<span class="sourceLineNo">182</span> connInfo = new ConnectionInfo(conn, userName);<a name="line.182"></a>
<span class="sourceLineNo">183</span> connections.put(userName, connInfo);<a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span> } finally {<a name="line.185"></a>
<span class="sourceLineNo">186</span> lock.unlock();<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span> return connInfo;<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> /**<a name="line.192"></a>
<span class="sourceLineNo">193</span> * Updates the access time for the current connection. Used to keep Connections alive for<a name="line.193"></a>
<span class="sourceLineNo">194</span> * long-lived scanners.<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @return whether we successfully updated the last access time<a name="line.195"></a>
<span class="sourceLineNo">196</span> */<a name="line.196"></a>
<span class="sourceLineNo">197</span> public boolean updateConnectionAccessTime() {<a name="line.197"></a>
<span class="sourceLineNo">198</span> String userName = getEffectiveUser();<a name="line.198"></a>
<span class="sourceLineNo">199</span> ConnectionInfo connInfo = connections.get(userName);<a name="line.199"></a>
<span class="sourceLineNo">200</span> if (connInfo != null) {<a name="line.200"></a>
<span class="sourceLineNo">201</span> return connInfo.updateAccessTime();<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span> return false;<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span> /** Returns Cluster ID for the HBase cluster or null if there is an err making the connection. */<a name="line.206"></a>
<span class="sourceLineNo">207</span> public String getClusterId() {<a name="line.207"></a>
<span class="sourceLineNo">208</span> try {<a name="line.208"></a>
<span class="sourceLineNo">209</span> ConnectionInfo connInfo = getCurrentConnection();<a name="line.209"></a>
<span class="sourceLineNo">210</span> return connInfo.connection.getClusterId();<a name="line.210"></a>
<span class="sourceLineNo">211</span> } catch (IOException e) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> LOG.error("Error getting connection: ", e);<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span> return null;<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span> class ConnectionInfo {<a name="line.217"></a>
<span class="sourceLineNo">218</span> final Connection connection;<a name="line.218"></a>
<span class="sourceLineNo">219</span> final String userName;<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span> volatile Admin admin;<a name="line.221"></a>
<span class="sourceLineNo">222</span> private long lastAccessTime;<a name="line.222"></a>
<span class="sourceLineNo">223</span> private boolean closed;<a name="line.223"></a>
<span class="sourceLineNo">224</span><a name="line.224"></a>
<span class="sourceLineNo">225</span> ConnectionInfo(Connection conn, String user) {<a name="line.225"></a>
<span class="sourceLineNo">226</span> lastAccessTime = EnvironmentEdgeManager.currentTime();<a name="line.226"></a>
<span class="sourceLineNo">227</span> connection = conn;<a name="line.227"></a>
<span class="sourceLineNo">228</span> closed = false;<a name="line.228"></a>
<span class="sourceLineNo">229</span> userName = user;<a name="line.229"></a>
<span class="sourceLineNo">230</span> }<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span> synchronized boolean updateAccessTime() {<a name="line.232"></a>
<span class="sourceLineNo">233</span> if (closed) {<a name="line.233"></a>
<span class="sourceLineNo">234</span> return false;<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span> if (connection.isAborted() || connection.isClosed()) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> LOG.info("Unexpected: cached Connection is aborted/closed, removed from cache");<a name="line.237"></a>
<span class="sourceLineNo">238</span> connections.remove(userName);<a name="line.238"></a>
<span class="sourceLineNo">239</span> return false;<a name="line.239"></a>
<span class="sourceLineNo">240</span> }<a name="line.240"></a>
<span class="sourceLineNo">241</span> lastAccessTime = EnvironmentEdgeManager.currentTime();<a name="line.241"></a>
<span class="sourceLineNo">242</span> return true;<a name="line.242"></a>
<span class="sourceLineNo">243</span> }<a name="line.243"></a>
<span class="sourceLineNo">244</span><a name="line.244"></a>
<span class="sourceLineNo">245</span> synchronized boolean timedOut(int maxIdleTime) {<a name="line.245"></a>
<span class="sourceLineNo">246</span> long timeoutTime = lastAccessTime + maxIdleTime;<a name="line.246"></a>
<span class="sourceLineNo">247</span> if (EnvironmentEdgeManager.currentTime() &gt; timeoutTime) {<a name="line.247"></a>
<span class="sourceLineNo">248</span> connections.remove(userName);<a name="line.248"></a>
<span class="sourceLineNo">249</span> closed = true;<a name="line.249"></a>
<span class="sourceLineNo">250</span> return true;<a name="line.250"></a>
<span class="sourceLineNo">251</span> }<a name="line.251"></a>
<span class="sourceLineNo">252</span> return false;<a name="line.252"></a>
<span class="sourceLineNo">253</span> }<a name="line.253"></a>
<span class="sourceLineNo">254</span> }<a name="line.254"></a>
<span class="sourceLineNo">255</span>}<a name="line.255"></a>
</pre>
</div>
</body>
</html>