blob: 878ed0eb4c8a4331d361d8215bb24e5d6ac80178 [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.rest, class: RESTServlet">
<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.rest;</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 org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.client.Admin;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.client.Table;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.filter.ParseFilter;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.security.UserProvider;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.util.ConnectionCache;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.util.JvmPauseMonitor;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.security.UserGroupInformation;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.security.authorize.ProxyUsers;</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">/**</span>
<span class="source-line-no">035</span><span id="line-35"> * Singleton class encapsulating global REST servlet state and functions.</span>
<span class="source-line-no">036</span><span id="line-36"> */</span>
<span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span>
<span class="source-line-no">038</span><span id="line-38">public class RESTServlet implements Constants {</span>
<span class="source-line-no">039</span><span id="line-39"> private static final Logger LOG = LoggerFactory.getLogger(RESTServlet.class);</span>
<span class="source-line-no">040</span><span id="line-40"> private static RESTServlet INSTANCE;</span>
<span class="source-line-no">041</span><span id="line-41"> private final Configuration conf;</span>
<span class="source-line-no">042</span><span id="line-42"> private final MetricsREST metrics;</span>
<span class="source-line-no">043</span><span id="line-43"> private final ConnectionCache connectionCache;</span>
<span class="source-line-no">044</span><span id="line-44"> private final UserGroupInformation realUser;</span>
<span class="source-line-no">045</span><span id="line-45"> private final JvmPauseMonitor pauseMonitor;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> public static final String CLEANUP_INTERVAL = "hbase.rest.connection.cleanup-interval";</span>
<span class="source-line-no">048</span><span id="line-48"> public static final String MAX_IDLETIME = "hbase.rest.connection.max-idletime";</span>
<span class="source-line-no">049</span><span id="line-49"> static final String HBASE_REST_SUPPORT_PROXYUSER = "hbase.rest.support.proxyuser";</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> UserGroupInformation getRealUser() {</span>
<span class="source-line-no">052</span><span id="line-52"> return realUser;</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"> /** Returns the RESTServlet singleton instance */</span>
<span class="source-line-no">056</span><span id="line-56"> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "MS_EXPOSE_REP",</span>
<span class="source-line-no">057</span><span id="line-57"> justification = "singleton pattern")</span>
<span class="source-line-no">058</span><span id="line-58"> public synchronized static RESTServlet getInstance() {</span>
<span class="source-line-no">059</span><span id="line-59"> assert (INSTANCE != null);</span>
<span class="source-line-no">060</span><span id="line-60"> return INSTANCE;</span>
<span class="source-line-no">061</span><span id="line-61"> }</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> /** Returns the ConnectionCache instance */</span>
<span class="source-line-no">064</span><span id="line-64"> public ConnectionCache getConnectionCache() {</span>
<span class="source-line-no">065</span><span id="line-65"> return connectionCache;</span>
<span class="source-line-no">066</span><span id="line-66"> }</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> /**</span>
<span class="source-line-no">069</span><span id="line-69"> * @param conf Existing configuration to use in rest servlet</span>
<span class="source-line-no">070</span><span id="line-70"> * @param userProvider the login user provider</span>
<span class="source-line-no">071</span><span id="line-71"> * @return the RESTServlet singleton instance</span>
<span class="source-line-no">072</span><span id="line-72"> */</span>
<span class="source-line-no">073</span><span id="line-73"> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "MS_EXPOSE_REP",</span>
<span class="source-line-no">074</span><span id="line-74"> justification = "singleton pattern")</span>
<span class="source-line-no">075</span><span id="line-75"> public synchronized static RESTServlet getInstance(Configuration conf, UserProvider userProvider)</span>
<span class="source-line-no">076</span><span id="line-76"> throws IOException {</span>
<span class="source-line-no">077</span><span id="line-77"> if (INSTANCE == null) {</span>
<span class="source-line-no">078</span><span id="line-78"> INSTANCE = new RESTServlet(conf, userProvider);</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"> return INSTANCE;</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"> public synchronized static void stop() {</span>
<span class="source-line-no">084</span><span id="line-84"> if (INSTANCE != null) {</span>
<span class="source-line-no">085</span><span id="line-85"> INSTANCE.shutdown();</span>
<span class="source-line-no">086</span><span id="line-86"> INSTANCE = null;</span>
<span class="source-line-no">087</span><span id="line-87"> }</span>
<span class="source-line-no">088</span><span id="line-88"> }</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"> * Constructor with existing configuration</span>
<span class="source-line-no">092</span><span id="line-92"> * @param conf existing configuration</span>
<span class="source-line-no">093</span><span id="line-93"> * @param userProvider the login user provider</span>
<span class="source-line-no">094</span><span id="line-94"> */</span>
<span class="source-line-no">095</span><span id="line-95"> RESTServlet(final Configuration conf, final UserProvider userProvider) throws IOException {</span>
<span class="source-line-no">096</span><span id="line-96"> this.realUser = userProvider.getCurrent().getUGI();</span>
<span class="source-line-no">097</span><span id="line-97"> this.conf = conf;</span>
<span class="source-line-no">098</span><span id="line-98"> registerCustomFilter(conf);</span>
<span class="source-line-no">099</span><span id="line-99"></span>
<span class="source-line-no">100</span><span id="line-100"> int cleanInterval = conf.getInt(CLEANUP_INTERVAL, 10 * 1000);</span>
<span class="source-line-no">101</span><span id="line-101"> int maxIdleTime = conf.getInt(MAX_IDLETIME, 10 * 60 * 1000);</span>
<span class="source-line-no">102</span><span id="line-102"> connectionCache = new ConnectionCache(conf, userProvider, cleanInterval, maxIdleTime);</span>
<span class="source-line-no">103</span><span id="line-103"> if (supportsProxyuser()) {</span>
<span class="source-line-no">104</span><span id="line-104"> ProxyUsers.refreshSuperUserGroupsConfiguration(conf);</span>
<span class="source-line-no">105</span><span id="line-105"> }</span>
<span class="source-line-no">106</span><span id="line-106"></span>
<span class="source-line-no">107</span><span id="line-107"> metrics = new MetricsREST();</span>
<span class="source-line-no">108</span><span id="line-108"></span>
<span class="source-line-no">109</span><span id="line-109"> pauseMonitor = new JvmPauseMonitor(conf, metrics.getSource());</span>
<span class="source-line-no">110</span><span id="line-110"> pauseMonitor.start();</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"> Admin getAdmin() throws IOException {</span>
<span class="source-line-no">114</span><span id="line-114"> return connectionCache.getAdmin();</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117"> /**</span>
<span class="source-line-no">118</span><span id="line-118"> * Caller closes the table afterwards.</span>
<span class="source-line-no">119</span><span id="line-119"> */</span>
<span class="source-line-no">120</span><span id="line-120"> Table getTable(String tableName) throws IOException {</span>
<span class="source-line-no">121</span><span id="line-121"> return connectionCache.getTable(tableName);</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"></span>
<span class="source-line-no">124</span><span id="line-124"> Configuration getConfiguration() {</span>
<span class="source-line-no">125</span><span id="line-125"> return conf;</span>
<span class="source-line-no">126</span><span id="line-126"> }</span>
<span class="source-line-no">127</span><span id="line-127"></span>
<span class="source-line-no">128</span><span id="line-128"> MetricsREST getMetrics() {</span>
<span class="source-line-no">129</span><span id="line-129"> return metrics;</span>
<span class="source-line-no">130</span><span id="line-130"> }</span>
<span class="source-line-no">131</span><span id="line-131"></span>
<span class="source-line-no">132</span><span id="line-132"> /**</span>
<span class="source-line-no">133</span><span id="line-133"> * Helper method to determine if server should only respond to GET HTTP method requests.</span>
<span class="source-line-no">134</span><span id="line-134"> * @return boolean for server read-only state</span>
<span class="source-line-no">135</span><span id="line-135"> */</span>
<span class="source-line-no">136</span><span id="line-136"> boolean isReadOnly() {</span>
<span class="source-line-no">137</span><span id="line-137"> return getConfiguration().getBoolean("hbase.rest.readonly", false);</span>
<span class="source-line-no">138</span><span id="line-138"> }</span>
<span class="source-line-no">139</span><span id="line-139"></span>
<span class="source-line-no">140</span><span id="line-140"> void setEffectiveUser(String effectiveUser) {</span>
<span class="source-line-no">141</span><span id="line-141"> connectionCache.setEffectiveUser(effectiveUser);</span>
<span class="source-line-no">142</span><span id="line-142"> }</span>
<span class="source-line-no">143</span><span id="line-143"></span>
<span class="source-line-no">144</span><span id="line-144"> /**</span>
<span class="source-line-no">145</span><span id="line-145"> * Shutdown any services that need to stop</span>
<span class="source-line-no">146</span><span id="line-146"> */</span>
<span class="source-line-no">147</span><span id="line-147"> void shutdown() {</span>
<span class="source-line-no">148</span><span id="line-148"> if (pauseMonitor != null) pauseMonitor.stop();</span>
<span class="source-line-no">149</span><span id="line-149"> if (connectionCache != null) connectionCache.shutdown();</span>
<span class="source-line-no">150</span><span id="line-150"> }</span>
<span class="source-line-no">151</span><span id="line-151"></span>
<span class="source-line-no">152</span><span id="line-152"> boolean supportsProxyuser() {</span>
<span class="source-line-no">153</span><span id="line-153"> return conf.getBoolean(HBASE_REST_SUPPORT_PROXYUSER, false);</span>
<span class="source-line-no">154</span><span id="line-154"> }</span>
<span class="source-line-no">155</span><span id="line-155"></span>
<span class="source-line-no">156</span><span id="line-156"> private void registerCustomFilter(Configuration conf) {</span>
<span class="source-line-no">157</span><span id="line-157"> String[] filterList = conf.getStrings(Constants.CUSTOM_FILTERS);</span>
<span class="source-line-no">158</span><span id="line-158"> if (filterList != null) {</span>
<span class="source-line-no">159</span><span id="line-159"> for (String filterClass : filterList) {</span>
<span class="source-line-no">160</span><span id="line-160"> String[] filterPart = filterClass.split(":");</span>
<span class="source-line-no">161</span><span id="line-161"> if (filterPart.length != 2) {</span>
<span class="source-line-no">162</span><span id="line-162"> LOG.warn("Invalid filter specification " + filterClass + " - skipping");</span>
<span class="source-line-no">163</span><span id="line-163"> } else {</span>
<span class="source-line-no">164</span><span id="line-164"> ParseFilter.registerFilter(filterPart[0], filterPart[1]);</span>
<span class="source-line-no">165</span><span id="line-165"> }</span>
<span class="source-line-no">166</span><span id="line-166"> }</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"> }</span>
<span class="source-line-no">169</span><span id="line-169">}</span>
</pre>
</div>
</main>
</body>
</html>