blob: 87d1813480c23bdb5be9e25c07ccf860dd681f00 [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>package org.apache.hadoop.hbase.master;<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.concurrent.Semaphore;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.Server;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.ServerName;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.TableDescriptors;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.TableName;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.TableNotDisabledException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.TableNotFoundException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.client.MasterSwitchType;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.client.NormalizeTableFilterParams;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.TableDescriptor;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.executor.ExecutorService;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.favored.FavoredNodesManager;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.master.assignment.AssignmentManager;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.master.janitor.CatalogJanitor;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.master.locking.LockManager;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.master.normalizer.RegionNormalizerManager;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.master.procedure.MasterProcedureEnv;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.master.replication.ReplicationPeerManager;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.master.replication.SyncReplicationReplayWALManager;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.master.snapshot.SnapshotManager;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.master.zksyncer.MetaLocationSyncer;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.procedure.MasterProcedureManagerHost;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.procedure2.LockedResource;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.procedure2.Procedure;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.procedure2.ProcedureEvent;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.procedure2.ProcedureExecutor;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.quotas.MasterQuotaManager;<a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.replication.ReplicationException;<a name="line.51"></a>
<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.replication.ReplicationPeerConfig;<a name="line.52"></a>
<span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.replication.ReplicationPeerDescription;<a name="line.53"></a>
<span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.replication.SyncReplicationState;<a name="line.54"></a>
<span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.replication.master.ReplicationLogCleanerBarrier;<a name="line.55"></a>
<span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.rsgroup.RSGroupInfoManager;<a name="line.56"></a>
<span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.security.access.AccessChecker;<a name="line.57"></a>
<span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.security.access.ZKPermissionWatcher;<a name="line.58"></a>
<span class="sourceLineNo">059</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>import org.apache.hbase.thirdparty.com.google.protobuf.Service;<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> * A curated subset of services provided by {@link HMaster}. For use internally only. Passed to<a name="line.64"></a>
<span class="sourceLineNo">065</span> * Managers, Services and Chores so can pass less-than-a full-on HMaster at test-time. Be judicious<a name="line.65"></a>
<span class="sourceLineNo">066</span> * adding API. Changes cause ripples through the code base.<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span>@InterfaceAudience.Private<a name="line.68"></a>
<span class="sourceLineNo">069</span>public interface MasterServices extends Server {<a name="line.69"></a>
<span class="sourceLineNo">070</span> /** Returns the underlying snapshot manager */<a name="line.70"></a>
<span class="sourceLineNo">071</span> SnapshotManager getSnapshotManager();<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /** Returns the underlying MasterProcedureManagerHost */<a name="line.73"></a>
<span class="sourceLineNo">074</span> MasterProcedureManagerHost getMasterProcedureManagerHost();<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /** Returns Master's instance of {@link ClusterSchema} */<a name="line.76"></a>
<span class="sourceLineNo">077</span> ClusterSchema getClusterSchema();<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /** Returns Master's instance of the {@link AssignmentManager} */<a name="line.79"></a>
<span class="sourceLineNo">080</span> AssignmentManager getAssignmentManager();<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> /** Returns Master's filesystem {@link MasterFileSystem} utility class. */<a name="line.82"></a>
<span class="sourceLineNo">083</span> MasterFileSystem getMasterFileSystem();<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> /** Returns Master's WALs {@link MasterWalManager} utility class. */<a name="line.85"></a>
<span class="sourceLineNo">086</span> MasterWalManager getMasterWalManager();<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> /** Returns Master's {@link ServerManager} instance. */<a name="line.88"></a>
<span class="sourceLineNo">089</span> ServerManager getServerManager();<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> /** Returns Master's instance of {@link ExecutorService} */<a name="line.91"></a>
<span class="sourceLineNo">092</span> ExecutorService getExecutorService();<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> /** Returns Master's instance of {@link TableStateManager} */<a name="line.94"></a>
<span class="sourceLineNo">095</span> TableStateManager getTableStateManager();<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> /** Returns Master's instance of {@link MasterCoprocessorHost} */<a name="line.97"></a>
<span class="sourceLineNo">098</span> MasterCoprocessorHost getMasterCoprocessorHost();<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> /** Returns Master's instance of {@link MasterQuotaManager} */<a name="line.100"></a>
<span class="sourceLineNo">101</span> MasterQuotaManager getMasterQuotaManager();<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> /** Returns Master's instance of {@link RegionNormalizerManager} */<a name="line.103"></a>
<span class="sourceLineNo">104</span> RegionNormalizerManager getRegionNormalizerManager();<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> /** Returns Master's instance of {@link CatalogJanitor} */<a name="line.106"></a>
<span class="sourceLineNo">107</span> CatalogJanitor getCatalogJanitor();<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> /** Returns Master's instance of {@link ProcedureExecutor} */<a name="line.109"></a>
<span class="sourceLineNo">110</span> ProcedureExecutor&lt;MasterProcedureEnv&gt; getMasterProcedureExecutor();<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> /** Returns Tripped when Master has finished initialization. */<a name="line.112"></a>
<span class="sourceLineNo">113</span> public ProcedureEvent&lt;?&gt; getInitializedEvent();<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> /** Returns Master's instance of {@link MetricsMaster} */<a name="line.115"></a>
<span class="sourceLineNo">116</span> MetricsMaster getMasterMetrics();<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> * Check table is modifiable; i.e. exists and is offline.<a name="line.119"></a>
<span class="sourceLineNo">120</span> * @param tableName Name of table to check.<a name="line.120"></a>
<span class="sourceLineNo">121</span> */<a name="line.121"></a>
<span class="sourceLineNo">122</span> // We actually throw the exceptions mentioned in the<a name="line.122"></a>
<span class="sourceLineNo">123</span> void checkTableModifiable(final TableName tableName)<a name="line.123"></a>
<span class="sourceLineNo">124</span> throws IOException, TableNotFoundException, TableNotDisabledException;<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>
<span class="sourceLineNo">127</span> * Create a table using the given table definition.<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @param desc The table definition<a name="line.128"></a>
<span class="sourceLineNo">129</span> * @param splitKeys Starting row keys for the initial table regions. If null a single region is<a name="line.129"></a>
<span class="sourceLineNo">130</span> * created.<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> long createTable(final TableDescriptor desc, final byte[][] splitKeys, final long nonceGroup,<a name="line.132"></a>
<span class="sourceLineNo">133</span> final long nonce) throws IOException;<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> /**<a name="line.135"></a>
<span class="sourceLineNo">136</span> * Create a system table using the given table definition.<a name="line.136"></a>
<span class="sourceLineNo">137</span> * @param tableDescriptor The system table definition a single region is created.<a name="line.137"></a>
<span class="sourceLineNo">138</span> */<a name="line.138"></a>
<span class="sourceLineNo">139</span> long createSystemTable(final TableDescriptor tableDescriptor) throws IOException;<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> /**<a name="line.141"></a>
<span class="sourceLineNo">142</span> * Delete a table<a name="line.142"></a>
<span class="sourceLineNo">143</span> * @param tableName The table name<a name="line.143"></a>
<span class="sourceLineNo">144</span> */<a name="line.144"></a>
<span class="sourceLineNo">145</span> long deleteTable(final TableName tableName, final long nonceGroup, final long nonce)<a name="line.145"></a>
<span class="sourceLineNo">146</span> throws IOException;<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> /**<a name="line.148"></a>
<span class="sourceLineNo">149</span> * Truncate a table<a name="line.149"></a>
<span class="sourceLineNo">150</span> * @param tableName The table name<a name="line.150"></a>
<span class="sourceLineNo">151</span> * @param preserveSplits True if the splits should be preserved<a name="line.151"></a>
<span class="sourceLineNo">152</span> */<a name="line.152"></a>
<span class="sourceLineNo">153</span> public long truncateTable(final TableName tableName, final boolean preserveSplits,<a name="line.153"></a>
<span class="sourceLineNo">154</span> final long nonceGroup, final long nonce) throws IOException;<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> /**<a name="line.156"></a>
<span class="sourceLineNo">157</span> * Modify the descriptor of an existing table<a name="line.157"></a>
<span class="sourceLineNo">158</span> * @param tableName The table name<a name="line.158"></a>
<span class="sourceLineNo">159</span> * @param descriptor The updated table descriptor<a name="line.159"></a>
<span class="sourceLineNo">160</span> */<a name="line.160"></a>
<span class="sourceLineNo">161</span> long modifyTable(final TableName tableName, final TableDescriptor descriptor,<a name="line.161"></a>
<span class="sourceLineNo">162</span> final long nonceGroup, final long nonce) throws IOException;<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> /**<a name="line.164"></a>
<span class="sourceLineNo">165</span> * Modify the store file tracker of an existing table<a name="line.165"></a>
<span class="sourceLineNo">166</span> */<a name="line.166"></a>
<span class="sourceLineNo">167</span> long modifyTableStoreFileTracker(final TableName tableName, final String dstSFT,<a name="line.167"></a>
<span class="sourceLineNo">168</span> final long nonceGroup, final long nonce) throws IOException;<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> /**<a name="line.170"></a>
<span class="sourceLineNo">171</span> * Enable an existing table<a name="line.171"></a>
<span class="sourceLineNo">172</span> * @param tableName The table name<a name="line.172"></a>
<span class="sourceLineNo">173</span> */<a name="line.173"></a>
<span class="sourceLineNo">174</span> long enableTable(final TableName tableName, final long nonceGroup, final long nonce)<a name="line.174"></a>
<span class="sourceLineNo">175</span> throws IOException;<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> /**<a name="line.177"></a>
<span class="sourceLineNo">178</span> * Disable an existing table<a name="line.178"></a>
<span class="sourceLineNo">179</span> * @param tableName The table name<a name="line.179"></a>
<span class="sourceLineNo">180</span> */<a name="line.180"></a>
<span class="sourceLineNo">181</span> long disableTable(final TableName tableName, final long nonceGroup, final long nonce)<a name="line.181"></a>
<span class="sourceLineNo">182</span> throws IOException;<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> /**<a name="line.184"></a>
<span class="sourceLineNo">185</span> * Add a new column to an existing table<a name="line.185"></a>
<span class="sourceLineNo">186</span> * @param tableName The table name<a name="line.186"></a>
<span class="sourceLineNo">187</span> * @param column The column definition<a name="line.187"></a>
<span class="sourceLineNo">188</span> */<a name="line.188"></a>
<span class="sourceLineNo">189</span> long addColumn(final TableName tableName, final ColumnFamilyDescriptor column,<a name="line.189"></a>
<span class="sourceLineNo">190</span> final long nonceGroup, final long nonce) throws IOException;<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> /**<a name="line.192"></a>
<span class="sourceLineNo">193</span> * Modify the column descriptor of an existing column in an existing table<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @param tableName The table name<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @param descriptor The updated column definition<a name="line.195"></a>
<span class="sourceLineNo">196</span> */<a name="line.196"></a>
<span class="sourceLineNo">197</span> long modifyColumn(final TableName tableName, final ColumnFamilyDescriptor descriptor,<a name="line.197"></a>
<span class="sourceLineNo">198</span> final long nonceGroup, final long nonce) throws IOException;<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span> /**<a name="line.200"></a>
<span class="sourceLineNo">201</span> * Modify the store file tracker of an existing column in an existing table<a name="line.201"></a>
<span class="sourceLineNo">202</span> */<a name="line.202"></a>
<span class="sourceLineNo">203</span> long modifyColumnStoreFileTracker(final TableName tableName, final byte[] family,<a name="line.203"></a>
<span class="sourceLineNo">204</span> final String dstSFT, final long nonceGroup, final long nonce) throws IOException;<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span> /**<a name="line.206"></a>
<span class="sourceLineNo">207</span> * Delete a column from an existing table<a name="line.207"></a>
<span class="sourceLineNo">208</span> * @param tableName The table name<a name="line.208"></a>
<span class="sourceLineNo">209</span> * @param columnName The column name<a name="line.209"></a>
<span class="sourceLineNo">210</span> */<a name="line.210"></a>
<span class="sourceLineNo">211</span> long deleteColumn(final TableName tableName, final byte[] columnName, final long nonceGroup,<a name="line.211"></a>
<span class="sourceLineNo">212</span> final long nonce) throws IOException;<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span> /**<a name="line.214"></a>
<span class="sourceLineNo">215</span> * Merge regions in a table.<a name="line.215"></a>
<span class="sourceLineNo">216</span> * @param regionsToMerge daughter regions to merge<a name="line.216"></a>
<span class="sourceLineNo">217</span> * @param forcible whether to force to merge even two regions are not adjacent<a name="line.217"></a>
<span class="sourceLineNo">218</span> * @param nonceGroup used to detect duplicate<a name="line.218"></a>
<span class="sourceLineNo">219</span> * @param nonce used to detect duplicate<a name="line.219"></a>
<span class="sourceLineNo">220</span> * @return procedure Id<a name="line.220"></a>
<span class="sourceLineNo">221</span> */<a name="line.221"></a>
<span class="sourceLineNo">222</span> long mergeRegions(final RegionInfo[] regionsToMerge, final boolean forcible,<a name="line.222"></a>
<span class="sourceLineNo">223</span> final long nonceGroup, final long nonce) throws IOException;<a name="line.223"></a>
<span class="sourceLineNo">224</span><a name="line.224"></a>
<span class="sourceLineNo">225</span> /**<a name="line.225"></a>
<span class="sourceLineNo">226</span> * Split a region.<a name="line.226"></a>
<span class="sourceLineNo">227</span> * @param regionInfo region to split<a name="line.227"></a>
<span class="sourceLineNo">228</span> * @param splitRow split point<a name="line.228"></a>
<span class="sourceLineNo">229</span> * @param nonceGroup used to detect duplicate<a name="line.229"></a>
<span class="sourceLineNo">230</span> * @param nonce used to detect duplicate<a name="line.230"></a>
<span class="sourceLineNo">231</span> * @return procedure Id<a name="line.231"></a>
<span class="sourceLineNo">232</span> */<a name="line.232"></a>
<span class="sourceLineNo">233</span> long splitRegion(final RegionInfo regionInfo, final byte[] splitRow, final long nonceGroup,<a name="line.233"></a>
<span class="sourceLineNo">234</span> final long nonce) throws IOException;<a name="line.234"></a>
<span class="sourceLineNo">235</span><a name="line.235"></a>
<span class="sourceLineNo">236</span> /** Returns Return table descriptors implementation. */<a name="line.236"></a>
<span class="sourceLineNo">237</span> TableDescriptors getTableDescriptors();<a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span> /**<a name="line.239"></a>
<span class="sourceLineNo">240</span> * Registers a new protocol buffer {@link Service} subclass as a master coprocessor endpoint.<a name="line.240"></a>
<span class="sourceLineNo">241</span> * &lt;p/&gt;<a name="line.241"></a>
<span class="sourceLineNo">242</span> * Only a single instance may be registered for a given {@link Service} subclass (the instances<a name="line.242"></a>
<span class="sourceLineNo">243</span> * are keyed on<a name="line.243"></a>
<span class="sourceLineNo">244</span> * {@link org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.ServiceDescriptor#getFullName()}.<a name="line.244"></a>
<span class="sourceLineNo">245</span> * After the first registration, subsequent calls with the same service name will fail with a<a name="line.245"></a>
<span class="sourceLineNo">246</span> * return value of {@code false}.<a name="line.246"></a>
<span class="sourceLineNo">247</span> * @param instance the {@code Service} subclass instance to expose as a coprocessor endpoint<a name="line.247"></a>
<span class="sourceLineNo">248</span> * @return {@code true} if the registration was successful, {@code false} otherwise<a name="line.248"></a>
<span class="sourceLineNo">249</span> */<a name="line.249"></a>
<span class="sourceLineNo">250</span> boolean registerService(Service instance);<a name="line.250"></a>
<span class="sourceLineNo">251</span><a name="line.251"></a>
<span class="sourceLineNo">252</span> /** Returns true if master is the active one */<a name="line.252"></a>
<span class="sourceLineNo">253</span> boolean isActiveMaster();<a name="line.253"></a>
<span class="sourceLineNo">254</span><a name="line.254"></a>
<span class="sourceLineNo">255</span> /** Returns true if master is initialized */<a name="line.255"></a>
<span class="sourceLineNo">256</span> boolean isInitialized();<a name="line.256"></a>
<span class="sourceLineNo">257</span><a name="line.257"></a>
<span class="sourceLineNo">258</span> /**<a name="line.258"></a>
<span class="sourceLineNo">259</span> * @return true if master is in maintanceMode<a name="line.259"></a>
<span class="sourceLineNo">260</span> * @throws IOException if the inquiry failed due to an IO problem<a name="line.260"></a>
<span class="sourceLineNo">261</span> */<a name="line.261"></a>
<span class="sourceLineNo">262</span> boolean isInMaintenanceMode();<a name="line.262"></a>
<span class="sourceLineNo">263</span><a name="line.263"></a>
<span class="sourceLineNo">264</span> /**<a name="line.264"></a>
<span class="sourceLineNo">265</span> * Checks master state before initiating action over region topology.<a name="line.265"></a>
<span class="sourceLineNo">266</span> * @param action the name of the action under consideration, for logging.<a name="line.266"></a>
<span class="sourceLineNo">267</span> * @return {@code true} when the caller should exit early, {@code false} otherwise.<a name="line.267"></a>
<span class="sourceLineNo">268</span> */<a name="line.268"></a>
<span class="sourceLineNo">269</span> boolean skipRegionManagementAction(final String action);<a name="line.269"></a>
<span class="sourceLineNo">270</span><a name="line.270"></a>
<span class="sourceLineNo">271</span> /**<a name="line.271"></a>
<span class="sourceLineNo">272</span> * Abort a procedure.<a name="line.272"></a>
<span class="sourceLineNo">273</span> * @param procId ID of the procedure<a name="line.273"></a>
<span class="sourceLineNo">274</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.274"></a>
<span class="sourceLineNo">275</span> * @return true if aborted, false if procedure already completed or does not exist<a name="line.275"></a>
<span class="sourceLineNo">276</span> */<a name="line.276"></a>
<span class="sourceLineNo">277</span> public boolean abortProcedure(final long procId, final boolean mayInterruptIfRunning)<a name="line.277"></a>
<span class="sourceLineNo">278</span> throws IOException;<a name="line.278"></a>
<span class="sourceLineNo">279</span><a name="line.279"></a>
<span class="sourceLineNo">280</span> /**<a name="line.280"></a>
<span class="sourceLineNo">281</span> * Get procedures<a name="line.281"></a>
<span class="sourceLineNo">282</span> * @return procedure list<a name="line.282"></a>
<span class="sourceLineNo">283</span> */<a name="line.283"></a>
<span class="sourceLineNo">284</span> public List&lt;Procedure&lt;?&gt;&gt; getProcedures() throws IOException;<a name="line.284"></a>
<span class="sourceLineNo">285</span><a name="line.285"></a>
<span class="sourceLineNo">286</span> /**<a name="line.286"></a>
<span class="sourceLineNo">287</span> * Get locks<a name="line.287"></a>
<span class="sourceLineNo">288</span> * @return lock list<a name="line.288"></a>
<span class="sourceLineNo">289</span> */<a name="line.289"></a>
<span class="sourceLineNo">290</span> public List&lt;LockedResource&gt; getLocks() throws IOException;<a name="line.290"></a>
<span class="sourceLineNo">291</span><a name="line.291"></a>
<span class="sourceLineNo">292</span> /**<a name="line.292"></a>
<span class="sourceLineNo">293</span> * Get list of table descriptors by namespace<a name="line.293"></a>
<span class="sourceLineNo">294</span> * @param name namespace name<a name="line.294"></a>
<span class="sourceLineNo">295</span> */<a name="line.295"></a>
<span class="sourceLineNo">296</span> public List&lt;TableDescriptor&gt; listTableDescriptorsByNamespace(String name) throws IOException;<a name="line.296"></a>
<span class="sourceLineNo">297</span><a name="line.297"></a>
<span class="sourceLineNo">298</span> /**<a name="line.298"></a>
<span class="sourceLineNo">299</span> * Get list of table names by namespace<a name="line.299"></a>
<span class="sourceLineNo">300</span> * @param name namespace name<a name="line.300"></a>
<span class="sourceLineNo">301</span> * @return table names<a name="line.301"></a>
<span class="sourceLineNo">302</span> */<a name="line.302"></a>
<span class="sourceLineNo">303</span> public List&lt;TableName&gt; listTableNamesByNamespace(String name) throws IOException;<a name="line.303"></a>
<span class="sourceLineNo">304</span><a name="line.304"></a>
<span class="sourceLineNo">305</span> /**<a name="line.305"></a>
<span class="sourceLineNo">306</span> * @param table the table for which last successful major compaction time is queried<a name="line.306"></a>
<span class="sourceLineNo">307</span> * @return the timestamp of the last successful major compaction for the passed table, or 0 if no<a name="line.307"></a>
<span class="sourceLineNo">308</span> * HFile resulting from a major compaction exists<a name="line.308"></a>
<span class="sourceLineNo">309</span> */<a name="line.309"></a>
<span class="sourceLineNo">310</span> public long getLastMajorCompactionTimestamp(TableName table) throws IOException;<a name="line.310"></a>
<span class="sourceLineNo">311</span><a name="line.311"></a>
<span class="sourceLineNo">312</span> /**<a name="line.312"></a>
<span class="sourceLineNo">313</span> * Returns the timestamp of the last successful major compaction for the passed region or 0 if no<a name="line.313"></a>
<span class="sourceLineNo">314</span> * HFile resulting from a major compaction exists<a name="line.314"></a>
<span class="sourceLineNo">315</span> */<a name="line.315"></a>
<span class="sourceLineNo">316</span> public long getLastMajorCompactionTimestampForRegion(byte[] regionName) throws IOException;<a name="line.316"></a>
<span class="sourceLineNo">317</span><a name="line.317"></a>
<span class="sourceLineNo">318</span> /** Returns load balancer */<a name="line.318"></a>
<span class="sourceLineNo">319</span> public LoadBalancer getLoadBalancer();<a name="line.319"></a>
<span class="sourceLineNo">320</span><a name="line.320"></a>
<span class="sourceLineNo">321</span> boolean isSplitOrMergeEnabled(MasterSwitchType switchType);<a name="line.321"></a>
<span class="sourceLineNo">322</span><a name="line.322"></a>
<span class="sourceLineNo">323</span> /** Returns Favored Nodes Manager */<a name="line.323"></a>
<span class="sourceLineNo">324</span> public FavoredNodesManager getFavoredNodesManager();<a name="line.324"></a>
<span class="sourceLineNo">325</span><a name="line.325"></a>
<span class="sourceLineNo">326</span> /**<a name="line.326"></a>
<span class="sourceLineNo">327</span> * Add a new replication peer for replicating data to slave cluster<a name="line.327"></a>
<span class="sourceLineNo">328</span> * @param peerId a short name that identifies the peer<a name="line.328"></a>
<span class="sourceLineNo">329</span> * @param peerConfig configuration for the replication slave cluster<a name="line.329"></a>
<span class="sourceLineNo">330</span> * @param enabled peer state, true if ENABLED and false if DISABLED<a name="line.330"></a>
<span class="sourceLineNo">331</span> */<a name="line.331"></a>
<span class="sourceLineNo">332</span> long addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig, boolean enabled)<a name="line.332"></a>
<span class="sourceLineNo">333</span> throws ReplicationException, IOException;<a name="line.333"></a>
<span class="sourceLineNo">334</span><a name="line.334"></a>
<span class="sourceLineNo">335</span> /**<a name="line.335"></a>
<span class="sourceLineNo">336</span> * Removes a peer and stops the replication<a name="line.336"></a>
<span class="sourceLineNo">337</span> * @param peerId a short name that identifies the peer<a name="line.337"></a>
<span class="sourceLineNo">338</span> */<a name="line.338"></a>
<span class="sourceLineNo">339</span> long removeReplicationPeer(String peerId) throws ReplicationException, IOException;<a name="line.339"></a>
<span class="sourceLineNo">340</span><a name="line.340"></a>
<span class="sourceLineNo">341</span> /**<a name="line.341"></a>
<span class="sourceLineNo">342</span> * Restart the replication stream to the specified peer<a name="line.342"></a>
<span class="sourceLineNo">343</span> * @param peerId a short name that identifies the peer<a name="line.343"></a>
<span class="sourceLineNo">344</span> */<a name="line.344"></a>
<span class="sourceLineNo">345</span> long enableReplicationPeer(String peerId) throws ReplicationException, IOException;<a name="line.345"></a>
<span class="sourceLineNo">346</span><a name="line.346"></a>
<span class="sourceLineNo">347</span> /**<a name="line.347"></a>
<span class="sourceLineNo">348</span> * Stop the replication stream to the specified peer<a name="line.348"></a>
<span class="sourceLineNo">349</span> * @param peerId a short name that identifies the peer<a name="line.349"></a>
<span class="sourceLineNo">350</span> */<a name="line.350"></a>
<span class="sourceLineNo">351</span> long disableReplicationPeer(String peerId) throws ReplicationException, IOException;<a name="line.351"></a>
<span class="sourceLineNo">352</span><a name="line.352"></a>
<span class="sourceLineNo">353</span> /**<a name="line.353"></a>
<span class="sourceLineNo">354</span> * Returns the configured ReplicationPeerConfig for the specified peer<a name="line.354"></a>
<span class="sourceLineNo">355</span> * @param peerId a short name that identifies the peer<a name="line.355"></a>
<span class="sourceLineNo">356</span> * @return ReplicationPeerConfig for the peer<a name="line.356"></a>
<span class="sourceLineNo">357</span> */<a name="line.357"></a>
<span class="sourceLineNo">358</span> ReplicationPeerConfig getReplicationPeerConfig(String peerId)<a name="line.358"></a>
<span class="sourceLineNo">359</span> throws ReplicationException, IOException;<a name="line.359"></a>
<span class="sourceLineNo">360</span><a name="line.360"></a>
<span class="sourceLineNo">361</span> /**<a name="line.361"></a>
<span class="sourceLineNo">362</span> * Returns the {@link ReplicationPeerManager}.<a name="line.362"></a>
<span class="sourceLineNo">363</span> */<a name="line.363"></a>
<span class="sourceLineNo">364</span> ReplicationPeerManager getReplicationPeerManager();<a name="line.364"></a>
<span class="sourceLineNo">365</span><a name="line.365"></a>
<span class="sourceLineNo">366</span> /**<a name="line.366"></a>
<span class="sourceLineNo">367</span> * Returns the {@link ReplicationLogCleanerBarrier}. It will be used at multiple places so we put<a name="line.367"></a>
<span class="sourceLineNo">368</span> * it in MasterServices directly.<a name="line.368"></a>
<span class="sourceLineNo">369</span> */<a name="line.369"></a>
<span class="sourceLineNo">370</span> ReplicationLogCleanerBarrier getReplicationLogCleanerBarrier();<a name="line.370"></a>
<span class="sourceLineNo">371</span><a name="line.371"></a>
<span class="sourceLineNo">372</span> /**<a name="line.372"></a>
<span class="sourceLineNo">373</span> * Returns the SyncReplicationPeerLock.<a name="line.373"></a>
<span class="sourceLineNo">374</span> */<a name="line.374"></a>
<span class="sourceLineNo">375</span> Semaphore getSyncReplicationPeerLock();<a name="line.375"></a>
<span class="sourceLineNo">376</span><a name="line.376"></a>
<span class="sourceLineNo">377</span> /**<a name="line.377"></a>
<span class="sourceLineNo">378</span> * Returns the {@link SyncReplicationReplayWALManager}.<a name="line.378"></a>
<span class="sourceLineNo">379</span> */<a name="line.379"></a>
<span class="sourceLineNo">380</span> SyncReplicationReplayWALManager getSyncReplicationReplayWALManager();<a name="line.380"></a>
<span class="sourceLineNo">381</span><a name="line.381"></a>
<span class="sourceLineNo">382</span> /**<a name="line.382"></a>
<span class="sourceLineNo">383</span> * Update the peerConfig for the specified peer<a name="line.383"></a>
<span class="sourceLineNo">384</span> * @param peerId a short name that identifies the peer<a name="line.384"></a>
<span class="sourceLineNo">385</span> * @param peerConfig new config for the peer<a name="line.385"></a>
<span class="sourceLineNo">386</span> */<a name="line.386"></a>
<span class="sourceLineNo">387</span> long updateReplicationPeerConfig(String peerId, ReplicationPeerConfig peerConfig)<a name="line.387"></a>
<span class="sourceLineNo">388</span> throws ReplicationException, IOException;<a name="line.388"></a>
<span class="sourceLineNo">389</span><a name="line.389"></a>
<span class="sourceLineNo">390</span> /**<a name="line.390"></a>
<span class="sourceLineNo">391</span> * Return a list of replication peers.<a name="line.391"></a>
<span class="sourceLineNo">392</span> * @param regex The regular expression to match peer id<a name="line.392"></a>
<span class="sourceLineNo">393</span> * @return a list of replication peers description<a name="line.393"></a>
<span class="sourceLineNo">394</span> */<a name="line.394"></a>
<span class="sourceLineNo">395</span> List&lt;ReplicationPeerDescription&gt; listReplicationPeers(String regex)<a name="line.395"></a>
<span class="sourceLineNo">396</span> throws ReplicationException, IOException;<a name="line.396"></a>
<span class="sourceLineNo">397</span><a name="line.397"></a>
<span class="sourceLineNo">398</span> /**<a name="line.398"></a>
<span class="sourceLineNo">399</span> * Set current cluster state for a synchronous replication peer.<a name="line.399"></a>
<span class="sourceLineNo">400</span> * @param peerId a short name that identifies the peer<a name="line.400"></a>
<span class="sourceLineNo">401</span> * @param clusterState state of current cluster<a name="line.401"></a>
<span class="sourceLineNo">402</span> */<a name="line.402"></a>
<span class="sourceLineNo">403</span> long transitReplicationPeerSyncReplicationState(String peerId, SyncReplicationState clusterState)<a name="line.403"></a>
<span class="sourceLineNo">404</span> throws ReplicationException, IOException;<a name="line.404"></a>
<span class="sourceLineNo">405</span><a name="line.405"></a>
<span class="sourceLineNo">406</span> boolean replicationPeerModificationSwitch(boolean on) throws IOException;<a name="line.406"></a>
<span class="sourceLineNo">407</span><a name="line.407"></a>
<span class="sourceLineNo">408</span> boolean isReplicationPeerModificationEnabled();<a name="line.408"></a>
<span class="sourceLineNo">409</span><a name="line.409"></a>
<span class="sourceLineNo">410</span> /** Returns {@link LockManager} to lock namespaces/tables/regions. */<a name="line.410"></a>
<span class="sourceLineNo">411</span> LockManager getLockManager();<a name="line.411"></a>
<span class="sourceLineNo">412</span><a name="line.412"></a>
<span class="sourceLineNo">413</span> public String getRegionServerVersion(final ServerName sn);<a name="line.413"></a>
<span class="sourceLineNo">414</span><a name="line.414"></a>
<span class="sourceLineNo">415</span> /**<a name="line.415"></a>
<span class="sourceLineNo">416</span> * Called when a new RegionServer is added to the cluster. Checks if new server has a newer<a name="line.416"></a>
<span class="sourceLineNo">417</span> * version than any existing server and will move system tables there if so.<a name="line.417"></a>
<span class="sourceLineNo">418</span> */<a name="line.418"></a>
<span class="sourceLineNo">419</span> public void checkIfShouldMoveSystemRegionAsync();<a name="line.419"></a>
<span class="sourceLineNo">420</span><a name="line.420"></a>
<span class="sourceLineNo">421</span> String getClientIdAuditPrefix();<a name="line.421"></a>
<span class="sourceLineNo">422</span><a name="line.422"></a>
<span class="sourceLineNo">423</span> /** Returns True if cluster is up; false if cluster is not up (we are shutting down). */<a name="line.423"></a>
<span class="sourceLineNo">424</span> boolean isClusterUp();<a name="line.424"></a>
<span class="sourceLineNo">425</span><a name="line.425"></a>
<span class="sourceLineNo">426</span> /** Returns return null if current is zk-based WAL splitting */<a name="line.426"></a>
<span class="sourceLineNo">427</span> default SplitWALManager getSplitWALManager() {<a name="line.427"></a>
<span class="sourceLineNo">428</span> return null;<a name="line.428"></a>
<span class="sourceLineNo">429</span> }<a name="line.429"></a>
<span class="sourceLineNo">430</span><a name="line.430"></a>
<span class="sourceLineNo">431</span> /** Returns the {@link AccessChecker} */<a name="line.431"></a>
<span class="sourceLineNo">432</span> AccessChecker getAccessChecker();<a name="line.432"></a>
<span class="sourceLineNo">433</span><a name="line.433"></a>
<span class="sourceLineNo">434</span> /** Returns the {@link ZKPermissionWatcher} */<a name="line.434"></a>
<span class="sourceLineNo">435</span> ZKPermissionWatcher getZKPermissionWatcher();<a name="line.435"></a>
<span class="sourceLineNo">436</span><a name="line.436"></a>
<span class="sourceLineNo">437</span> /**<a name="line.437"></a>
<span class="sourceLineNo">438</span> * Execute region plans with throttling<a name="line.438"></a>
<span class="sourceLineNo">439</span> * @param plans to execute<a name="line.439"></a>
<span class="sourceLineNo">440</span> * @return succeeded plans<a name="line.440"></a>
<span class="sourceLineNo">441</span> */<a name="line.441"></a>
<span class="sourceLineNo">442</span> List&lt;RegionPlan&gt; executeRegionPlansWithThrottling(List&lt;RegionPlan&gt; plans);<a name="line.442"></a>
<span class="sourceLineNo">443</span><a name="line.443"></a>
<span class="sourceLineNo">444</span> /**<a name="line.444"></a>
<span class="sourceLineNo">445</span> * Run the ReplicationBarrierChore.<a name="line.445"></a>
<span class="sourceLineNo">446</span> */<a name="line.446"></a>
<span class="sourceLineNo">447</span> void runReplicationBarrierCleaner();<a name="line.447"></a>
<span class="sourceLineNo">448</span><a name="line.448"></a>
<span class="sourceLineNo">449</span> /** Returns the {@link RSGroupInfoManager} */<a name="line.449"></a>
<span class="sourceLineNo">450</span> RSGroupInfoManager getRSGroupInfoManager();<a name="line.450"></a>
<span class="sourceLineNo">451</span><a name="line.451"></a>
<span class="sourceLineNo">452</span> /**<a name="line.452"></a>
<span class="sourceLineNo">453</span> * Queries the state of the {@code LoadBalancerStateStore}. If the balancer is not initialized,<a name="line.453"></a>
<span class="sourceLineNo">454</span> * false is returned.<a name="line.454"></a>
<span class="sourceLineNo">455</span> * @return The state of the load balancer, or false if the load balancer isn't defined.<a name="line.455"></a>
<span class="sourceLineNo">456</span> */<a name="line.456"></a>
<span class="sourceLineNo">457</span> boolean isBalancerOn();<a name="line.457"></a>
<span class="sourceLineNo">458</span><a name="line.458"></a>
<span class="sourceLineNo">459</span> /**<a name="line.459"></a>
<span class="sourceLineNo">460</span> * Perform normalization of cluster.<a name="line.460"></a>
<span class="sourceLineNo">461</span> * @param ntfp Selection criteria for identifying which tables to normalize.<a name="line.461"></a>
<span class="sourceLineNo">462</span> * @param isHighPriority {@code true} when these requested tables should skip to the front of the<a name="line.462"></a>
<span class="sourceLineNo">463</span> * queue.<a name="line.463"></a>
<span class="sourceLineNo">464</span> * @return {@code true} when the request was submitted, {@code false} otherwise.<a name="line.464"></a>
<span class="sourceLineNo">465</span> */<a name="line.465"></a>
<span class="sourceLineNo">466</span> boolean normalizeRegions(final NormalizeTableFilterParams ntfp, final boolean isHighPriority)<a name="line.466"></a>
<span class="sourceLineNo">467</span> throws IOException;<a name="line.467"></a>
<span class="sourceLineNo">468</span><a name="line.468"></a>
<span class="sourceLineNo">469</span> /**<a name="line.469"></a>
<span class="sourceLineNo">470</span> * Get the meta location syncer.<a name="line.470"></a>
<span class="sourceLineNo">471</span> * &lt;p/&gt;<a name="line.471"></a>
<span class="sourceLineNo">472</span> * We need to get this in MTP to tell the syncer the new meta replica count.<a name="line.472"></a>
<span class="sourceLineNo">473</span> */<a name="line.473"></a>
<span class="sourceLineNo">474</span> MetaLocationSyncer getMetaLocationSyncer();<a name="line.474"></a>
<span class="sourceLineNo">475</span><a name="line.475"></a>
<span class="sourceLineNo">476</span> /**<a name="line.476"></a>
<span class="sourceLineNo">477</span> * Flush master local region<a name="line.477"></a>
<span class="sourceLineNo">478</span> */<a name="line.478"></a>
<span class="sourceLineNo">479</span> void flushMasterStore() throws IOException;<a name="line.479"></a>
<span class="sourceLineNo">480</span><a name="line.480"></a>
<span class="sourceLineNo">481</span> /**<a name="line.481"></a>
<span class="sourceLineNo">482</span> * Flush an existing table<a name="line.482"></a>
<span class="sourceLineNo">483</span> * @param tableName The table name<a name="line.483"></a>
<span class="sourceLineNo">484</span> * @param columnFamilies The column families to flush<a name="line.484"></a>
<span class="sourceLineNo">485</span> * @param nonceGroup the nonce group<a name="line.485"></a>
<span class="sourceLineNo">486</span> * @param nonce the nonce<a name="line.486"></a>
<span class="sourceLineNo">487</span> * @return the flush procedure id<a name="line.487"></a>
<span class="sourceLineNo">488</span> */<a name="line.488"></a>
<span class="sourceLineNo">489</span> long flushTable(final TableName tableName, final List&lt;byte[]&gt; columnFamilies,<a name="line.489"></a>
<span class="sourceLineNo">490</span> final long nonceGroup, final long nonce) throws IOException;<a name="line.490"></a>
<span class="sourceLineNo">491</span>}<a name="line.491"></a>
</pre>
</div>
</body>
</html>