blob: 4f055ea0fd4a013d147881efdee4837bc829793b [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, interface: Server">
<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;</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.fs.FileSystem;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.client.AsyncClusterConnection;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.client.AsyncConnection;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.Connection;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.zookeeper.ZKWatcher;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">028</span><span id="line-28"></span>
<span class="source-line-no">029</span><span id="line-29">/**</span>
<span class="source-line-no">030</span><span id="line-30"> * Defines a curated set of shared functions implemented by HBase servers (Masters and</span>
<span class="source-line-no">031</span><span id="line-31"> * RegionServers). For use internally only. Be judicious adding API. Changes cause ripples through</span>
<span class="source-line-no">032</span><span id="line-32"> * the code base.</span>
<span class="source-line-no">033</span><span id="line-33"> */</span>
<span class="source-line-no">034</span><span id="line-34">@InterfaceAudience.Private</span>
<span class="source-line-no">035</span><span id="line-35">public interface Server extends Abortable, Stoppable {</span>
<span class="source-line-no">036</span><span id="line-36"> /**</span>
<span class="source-line-no">037</span><span id="line-37"> * Gets the configuration object for this server.</span>
<span class="source-line-no">038</span><span id="line-38"> */</span>
<span class="source-line-no">039</span><span id="line-39"> Configuration getConfiguration();</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"> * Gets the ZooKeeper instance for this server.</span>
<span class="source-line-no">043</span><span id="line-43"> */</span>
<span class="source-line-no">044</span><span id="line-44"> ZKWatcher getZooKeeper();</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> /**</span>
<span class="source-line-no">047</span><span id="line-47"> * Returns a reference to the servers' connection. Important note: this method returns a reference</span>
<span class="source-line-no">048</span><span id="line-48"> * to Connection which is managed by Server itself, so callers must NOT attempt to close</span>
<span class="source-line-no">049</span><span id="line-49"> * connection obtained.</span>
<span class="source-line-no">050</span><span id="line-50"> */</span>
<span class="source-line-no">051</span><span id="line-51"> default Connection getConnection() {</span>
<span class="source-line-no">052</span><span id="line-52"> return getAsyncConnection().toConnection();</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"> Connection createConnection(Configuration conf) throws IOException;</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"> * Returns a reference to the servers' async connection.</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"> * Important note: this method returns a reference to Connection which is managed by Server</span>
<span class="source-line-no">061</span><span id="line-61"> * itself, so callers must NOT attempt to close connection obtained.</span>
<span class="source-line-no">062</span><span id="line-62"> */</span>
<span class="source-line-no">063</span><span id="line-63"> default AsyncConnection getAsyncConnection() {</span>
<span class="source-line-no">064</span><span id="line-64"> return getAsyncClusterConnection();</span>
<span class="source-line-no">065</span><span id="line-65"> }</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"> * Returns a reference to the servers' async cluster connection.</span>
<span class="source-line-no">069</span><span id="line-69"> * &lt;p/&gt;</span>
<span class="source-line-no">070</span><span id="line-70"> * Important note: this method returns a reference to Connection which is managed by Server</span>
<span class="source-line-no">071</span><span id="line-71"> * itself, so callers must NOT attempt to close connection obtained.</span>
<span class="source-line-no">072</span><span id="line-72"> */</span>
<span class="source-line-no">073</span><span id="line-73"> AsyncClusterConnection getAsyncClusterConnection();</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75"> /** Returns The unique server name for this server. */</span>
<span class="source-line-no">076</span><span id="line-76"> ServerName getServerName();</span>
<span class="source-line-no">077</span><span id="line-77"></span>
<span class="source-line-no">078</span><span id="line-78"> /**</span>
<span class="source-line-no">079</span><span id="line-79"> * Get CoordinatedStateManager instance for this server.</span>
<span class="source-line-no">080</span><span id="line-80"> */</span>
<span class="source-line-no">081</span><span id="line-81"> CoordinatedStateManager getCoordinatedStateManager();</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 {@link ChoreService} instance for this server */</span>
<span class="source-line-no">084</span><span id="line-84"> ChoreService getChoreService();</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> /** Returns Return the FileSystem object used (can return null!). */</span>
<span class="source-line-no">087</span><span id="line-87"> // TODO: Distinguish between "dataFs" and "walFs".</span>
<span class="source-line-no">088</span><span id="line-88"> default FileSystem getFileSystem() {</span>
<span class="source-line-no">089</span><span id="line-89"> // This default is pretty dodgy!</span>
<span class="source-line-no">090</span><span id="line-90"> Configuration c = getConfiguration();</span>
<span class="source-line-no">091</span><span id="line-91"> FileSystem fs = null;</span>
<span class="source-line-no">092</span><span id="line-92"> try {</span>
<span class="source-line-no">093</span><span id="line-93"> if (c != null) {</span>
<span class="source-line-no">094</span><span id="line-94"> fs = FileSystem.get(c);</span>
<span class="source-line-no">095</span><span id="line-95"> }</span>
<span class="source-line-no">096</span><span id="line-96"> } catch (IOException e) {</span>
<span class="source-line-no">097</span><span id="line-97"> // If an exception, just return null</span>
<span class="source-line-no">098</span><span id="line-98"> }</span>
<span class="source-line-no">099</span><span id="line-99"> return fs;</span>
<span class="source-line-no">100</span><span id="line-100"> }</span>
<span class="source-line-no">101</span><span id="line-101"></span>
<span class="source-line-no">102</span><span id="line-102"> /** Returns True is the server is Stopping */</span>
<span class="source-line-no">103</span><span id="line-103"> // Note: This method is not part of the Stoppable Interface.</span>
<span class="source-line-no">104</span><span id="line-104"> default boolean isStopping() {</span>
<span class="source-line-no">105</span><span id="line-105"> return false;</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107">}</span>
</pre>
</div>
</main>
</body>
</html>