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