Google Git
Sign in
apache / hbase-site / 2e3aaee18b357604e6f6797bafb8e59d3025ccb0 / . / testdevapidocs / src-html / org / apache / hadoop / hbase / ClusterManager.ServiceType.html
blob: f27ea375389ad5e43da011fc215947014976603c [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><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.conf.Configurable;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * ClusterManager is an api to manage servers in a distributed environment. It provides services<a name="line.28"></a>
<span class="sourceLineNo">029</span> * for starting / stopping / killing Hadoop/HBase daemons. Concrete implementations provide actual<a name="line.29"></a>
<span class="sourceLineNo">030</span> * functionality for carrying out deployment-specific tasks.<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a>
<span class="sourceLineNo">033</span>interface ClusterManager extends Configurable {<a name="line.33"></a>
<span class="sourceLineNo">034</span> /**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Type of the service daemon<a name="line.35"></a>
<span class="sourceLineNo">036</span> */<a name="line.36"></a>
<span class="sourceLineNo">037</span> public static enum ServiceType {<a name="line.37"></a>
<span class="sourceLineNo">038</span> HADOOP_NAMENODE("namenode"),<a name="line.38"></a>
<span class="sourceLineNo">039</span> HADOOP_DATANODE("datanode"),<a name="line.39"></a>
<span class="sourceLineNo">040</span> HADOOP_JOBTRACKER("jobtracker"),<a name="line.40"></a>
<span class="sourceLineNo">041</span> HADOOP_TASKTRACKER("tasktracker"),<a name="line.41"></a>
<span class="sourceLineNo">042</span> ZOOKEEPER_SERVER("QuorumPeerMain"),<a name="line.42"></a>
<span class="sourceLineNo">043</span> HBASE_MASTER("master"),<a name="line.43"></a>
<span class="sourceLineNo">044</span> HBASE_REGIONSERVER("regionserver");<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private String name;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> ServiceType(String name) {<a name="line.48"></a>
<span class="sourceLineNo">049</span> this.name = name;<a name="line.49"></a>
<span class="sourceLineNo">050</span> }<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> public String getName() {<a name="line.52"></a>
<span class="sourceLineNo">053</span> return name;<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> @Override<a name="line.56"></a>
<span class="sourceLineNo">057</span> public String toString() {<a name="line.57"></a>
<span class="sourceLineNo">058</span> return getName();<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /**<a name="line.62"></a>
<span class="sourceLineNo">063</span> * Start the service on the given host<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> void start(ServiceType service, String hostname, int port) throws IOException;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Stop the service on the given host<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> void stop(ServiceType service, String hostname, int port) throws IOException;<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> /**<a name="line.72"></a>
<span class="sourceLineNo">073</span> * Restart the service on the given host<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> void restart(ServiceType service, String hostname, int port) throws IOException;<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> /**<a name="line.77"></a>
<span class="sourceLineNo">078</span> * Kills the service running on the given host<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> void kill(ServiceType service, String hostname, int port) throws IOException;<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> * Suspends the service running on the given host<a name="line.83"></a>
<span class="sourceLineNo">084</span> */<a name="line.84"></a>
<span class="sourceLineNo">085</span> void suspend(ServiceType service, String hostname, int port) throws IOException;<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Resumes the services running on the given host<a name="line.88"></a>
<span class="sourceLineNo">089</span> */<a name="line.89"></a>
<span class="sourceLineNo">090</span> void resume(ServiceType service, String hostname, int port) throws IOException;<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
<span class="sourceLineNo">093</span> * Returns whether the service is running on the remote host. This only checks whether the<a name="line.93"></a>
<span class="sourceLineNo">094</span> * service still has a pid.<a name="line.94"></a>
<span class="sourceLineNo">095</span> */<a name="line.95"></a>
<span class="sourceLineNo">096</span> boolean isRunning(ServiceType service, String hostname, int port) throws IOException;<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> /* TODO: further API ideas:<a name="line.98"></a>
<span class="sourceLineNo">099</span> *<a name="line.99"></a>
<span class="sourceLineNo">100</span> * //return services running on host:<a name="line.100"></a>
<span class="sourceLineNo">101</span> * ServiceType[] getRunningServicesOnHost(String hostname);<a name="line.101"></a>
<span class="sourceLineNo">102</span> *<a name="line.102"></a>
<span class="sourceLineNo">103</span> * //return which services can be run on host (for example, to query whether hmaster can run on this host)<a name="line.103"></a>
<span class="sourceLineNo">104</span> * ServiceType[] getRunnableServicesOnHost(String hostname);<a name="line.104"></a>
<span class="sourceLineNo">105</span> *<a name="line.105"></a>
<span class="sourceLineNo">106</span> * //return which hosts can run this service<a name="line.106"></a>
<span class="sourceLineNo">107</span> * String[] getRunnableHostsForService(ServiceType service);<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<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>
</pre>
</div>
</body>
</html>