| <!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.rsgroup;<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.List;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Set;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.TableName;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.master.MasterServices;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.net.Address;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>/**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Interface used to manage RSGroupInfo storage. An implementation has the option to support offline<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * mode. See {@code RSGroupBasedLoadBalancer}.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> */<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>@InterfaceAudience.Private<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>public interface RSGroupInfoManager {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> void start();<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> /**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Add given RSGroupInfo to existing list of group infos.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> */<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> void addRSGroup(RSGroupInfo rsGroupInfo) throws IOException;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> /**<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * Remove a region server group.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> void removeRSGroup(String groupName) throws IOException;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> /**<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * Move servers to a new group.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> void moveServers(Set<Address> servers, String targetGroupName) throws IOException;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Gets the group info of server.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> RSGroupInfo getRSGroupOfServer(Address serverHostPort) throws IOException;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> /**<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Gets {@code RSGroupInfo} for the given group name.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> RSGroupInfo getRSGroup(String groupName) throws IOException;<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> * List the existing {@code RSGroupInfo}s.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> List<RSGroupInfo> listRSGroups() throws IOException;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /**<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * Whether the manager is able to fully return group metadata<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @return whether the manager is in online mode<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> boolean isOnline();<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> * Remove decommissioned servers from rsgroup<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param servers set of servers to remove<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> void removeServers(Set<Address> servers) throws IOException;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> /**<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * Get {@code RSGroupInfo} for the given table.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> RSGroupInfo getRSGroupForTable(TableName tableName) throws IOException;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> static RSGroupInfoManager create(MasterServices master) throws IOException {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> if (RSGroupUtil.isRSGroupEnabled(master.getConfiguration())) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> return RSGroupInfoManagerImpl.getInstance(master);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> } else {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> return new DisabledRSGroupInfoManager(master.getServerManager());<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<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> /**<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * Balance a region server group.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> boolean balanceRSGroup(String groupName) throws IOException;<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> /**<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * Set group for tables.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> */<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> void setRSGroup(Set<TableName> tables, String groupName) throws IOException;<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * Determine {@code RSGroupInfo} for the given table.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @param tableName table name<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @return rsgroup name<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> */<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> String determineRSGroupInfoForTable(TableName tableName);<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> * Rename rsgroup<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @param oldName old rsgroup name<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param newName new rsgroup name<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @throws IOException<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> */<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> void renameRSGroup(String oldName, String newName) throws IOException;<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> * Update RSGroup configuration<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @param groupName the group name<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @param configuration new configuration of the group name to be set<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @throws IOException if a remote or network exception occurs<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> */<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> void updateRSGroupConfig(String groupName, Map<String, String> configuration) throws IOException;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span>}<a name="line.126"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
