| <!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.replication;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.List;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Map;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Set;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.SortedSet;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.fs.Path;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.ServerName;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Perform read/write to the replication queue storage.<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 ReplicationQueueStorage {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> /**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Remove a replication queue for a given regionserver.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @param serverName the name of the regionserver<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @param queueId a String that identifies the queue.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> */<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> void removeQueue(ServerName serverName, String queueId) throws ReplicationException;<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> * Add a new WAL file to the given queue for a given regionserver. If the queue does not exist it<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * is created.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @param serverName the name of the regionserver<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @param queueId a String that identifies the queue.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @param fileName name of the WAL<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> void addWAL(ServerName serverName, String queueId, String fileName) throws ReplicationException;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Remove an WAL file from the given queue for a given regionserver.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @param serverName the name of the regionserver<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @param queueId a String that identifies the queue.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @param fileName name of the WAL<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> void removeWAL(ServerName serverName, String queueId, String fileName)<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> throws ReplicationException;<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> * Set the current position for a specific WAL in a given queue for a given regionserver.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @param serverName the name of the regionserver<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @param queueId a String that identifies the queue<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @param fileName name of the WAL<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param position the current position in the file. Will ignore if less than or equal to 0.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @param lastSeqIds map with {encodedRegionName, sequenceId} pairs for serial replication.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> void setWALPosition(ServerName serverName, String queueId, String fileName, long position,<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> Map<String, Long> lastSeqIds) throws ReplicationException;<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> * Read the max sequence id of the specific region for a given peer. For serial replication, we<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * need the max sequenced id to decide whether we can push the next entries.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @param encodedRegionName the encoded region name<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @param peerId peer id<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @return the max sequence id of the specific region for a given peer.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> long getLastSequenceId(String encodedRegionName, String peerId) throws ReplicationException;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> /**<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * Set the max sequence id of a bunch of regions for a given peer. Will be called when setting up<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * a serial replication peer.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @param peerId peer id<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * @param lastSeqIds map with {encodedRegionName, sequenceId} pairs for serial replication.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> */<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> void setLastSequenceIds(String peerId, Map<String, Long> lastSeqIds) throws ReplicationException;<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> /**<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * Remove all the max sequence id record for the given peer.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param peerId peer id<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> void removeLastSequenceIds(String peerId) throws ReplicationException;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Remove the max sequence id record for the given peer and regions.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @param peerId peer id<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @param encodedRegionNames the encoded region names<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> void removeLastSequenceIds(String peerId, List<String> encodedRegionNames)<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> throws ReplicationException;<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> * Get the current position for a specific WAL in a given queue for a given regionserver.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @param serverName the name of the regionserver<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @param queueId a String that identifies the queue<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @param fileName name of the WAL<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @return the current position in the file<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> long getWALPosition(ServerName serverName, String queueId, String fileName)<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> throws ReplicationException;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> /**<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * Get a list of all WALs in the given queue on the given region server.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @param serverName the server name of the region server that owns the queue<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param queueId a String that identifies the queue<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @return a list of WALs<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> */<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> List<String> getWALsInQueue(ServerName serverName, String queueId) throws ReplicationException;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> /**<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * Get a list of all queues for the specified region server.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * @param serverName the server name of the region server that owns the set of queues<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @return a list of queueIds<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> */<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> List<String> getAllQueues(ServerName serverName) throws ReplicationException;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> /**<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * Change ownership for the queue identified by queueId and belongs to a dead region server.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @param sourceServerName the name of the dead region server<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @param destServerName the name of the target region server<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @param queueId the id of the queue<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @return the new PeerId and A SortedSet of WALs in its queue<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> Pair<String, SortedSet<String>> claimQueue(ServerName sourceServerName, String queueId,<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> ServerName destServerName) throws ReplicationException;<a name="line.136"></a> |
| <span class="sourceLineNo">137</span><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> /**<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * Remove the record of region server if the queue is empty.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> void removeReplicatorIfQueueIsEmpty(ServerName serverName) throws ReplicationException;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * Get a list of all region servers that have outstanding replication queues. These servers could<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * be alive, dead or from a previous run of the cluster.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * @return a list of server names<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> */<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> List<ServerName> getListOfReplicators() throws ReplicationException;<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> /**<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * Load all wals in all replication queues. This method guarantees to return a snapshot which<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * contains all WALs at the start of this call even there is concurrent queue failover. However,<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * some newly created WALs during the call may not be included.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> */<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> Set<String> getAllWALs() throws ReplicationException;<a name="line.155"></a> |
| <span class="sourceLineNo">156</span><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> /**<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * Add a peer to hfile reference queue if peer does not exist.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @param peerId peer cluster id to be added<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @throws ReplicationException if fails to add a peer id to hfile reference queue<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> */<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> void addPeerToHFileRefs(String peerId) throws ReplicationException;<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> * Remove a peer from hfile reference queue.<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @param peerId peer cluster id to be removed<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> */<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> void removePeerFromHFileRefs(String peerId) throws ReplicationException;<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> * Add new hfile references to the queue.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @param peerId peer cluster id to which the hfiles need to be replicated<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @param pairs list of pairs of { HFile location in staging dir, HFile path in region dir which<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * will be added in the queue }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * @throws ReplicationException if fails to add a hfile reference<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> */<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> void addHFileRefs(String peerId, List<Pair<Path, Path>> pairs) throws ReplicationException;<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> /**<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * Remove hfile references from the queue.<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @param peerId peer cluster id from which this hfile references needs to be removed<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @param files list of hfile references to be removed<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> */<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> void removeHFileRefs(String peerId, List<String> files) throws ReplicationException;<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> /**<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * Get list of all peers from hfile reference queue.<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @return a list of peer ids<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> */<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> List<String> getAllPeersFromHFileRefsQueue() throws ReplicationException;<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> * Get a list of all hfile references in the given peer.<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * @param peerId a String that identifies the peer<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * @return a list of hfile references<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> */<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> List<String> getReplicableHFiles(String peerId) throws ReplicationException;<a name="line.197"></a> |
| <span class="sourceLineNo">198</span><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> /**<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * Load all hfile references in all replication queues. This method guarantees to return a<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * snapshot which contains all hfile references at the start of this call. However, some newly<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * created hfile references during the call may not be included.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> */<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> Set<String> getAllHFileRefs() throws ReplicationException;<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> * Get full znode name for given region server<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @param serverName the name of the region server<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * @return full znode name<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> */<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> String getRsNode(ServerName serverName);<a name="line.211"></a> |
| <span class="sourceLineNo">212</span>}<a name="line.212"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
