| <!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.client.locking;<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 org.apache.hadoop.conf.Configuration;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.Abortable;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<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.client.NonceGenerator;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.client.RegionInfo;<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>import org.apache.yetus.audience.InterfaceStability;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockRequest;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockService;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockType;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>/**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Helper class to create "master locks" for namespaces, tables and regions. DEV-NOTE: At the moment<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * this class is used only by the RS for MOB, to prevent other MOB compaction to conflict. The RS<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * has already the stub of the LockService, so we have only one constructor that takes the<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * LockService stub. If in the future we are going to use this in other places we should add a<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * constructor that from conf or connection, creates the stub.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.TOOLS)<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>@InterfaceStability.Evolving<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>public class LockServiceClient {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> private final LockService.BlockingInterface stub;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> private final Configuration conf;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private final NonceGenerator ng;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> public LockServiceClient(final Configuration conf, final LockService.BlockingInterface stub,<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> final NonceGenerator ng) {<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> this.conf = conf;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> this.stub = stub;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> this.ng = ng;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> }<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * Create a new EntityLock object to acquire an exclusive or shared lock on a table. Internally,<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * the table namespace will also be locked in shared mode.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> public EntityLock tableLock(final TableName tableName, final boolean exclusive,<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> final String description, final Abortable abort) {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> LockRequest lockRequest = buildLockRequest(exclusive ? LockType.EXCLUSIVE : LockType.SHARED,<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> tableName.getNameAsString(), null, null, description, ng.getNonceGroup(), ng.newNonce());<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> return new EntityLock(conf, stub, lockRequest, abort);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /**<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * LocCreate a new EntityLock object to acquire exclusive lock on a namespace. Clients can not<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * acquire shared locks on namespace.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public EntityLock namespaceLock(String namespace, String description, Abortable abort) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> LockRequest lockRequest = buildLockRequest(LockType.EXCLUSIVE, namespace, null, null,<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> description, ng.getNonceGroup(), ng.newNonce());<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> return new EntityLock(conf, stub, lockRequest, abort);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> }<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * Create a new EntityLock object to acquire exclusive lock on multiple regions of same tables.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Internally, the table and its namespace will also be locked in shared mode.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public EntityLock regionLock(List<RegionInfo> regionInfos, String description, Abortable abort) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> LockRequest lockRequest = buildLockRequest(LockType.EXCLUSIVE, null, null, regionInfos,<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> description, ng.getNonceGroup(), ng.newNonce());<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> return new EntityLock(conf, stub, lockRequest, abort);<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> @InterfaceAudience.Private<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> public static LockRequest buildLockRequest(final LockType type, final String namespace,<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> final TableName tableName, final List<RegionInfo> regionInfos, final String description,<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> final long nonceGroup, final long nonce) {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> final LockRequest.Builder builder =<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> LockRequest.newBuilder().setLockType(type).setNonceGroup(nonceGroup).setNonce(nonce);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> if (regionInfos != null) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> for (RegionInfo hri : regionInfos) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> builder.addRegionInfo(ProtobufUtil.toRegionInfo(hri));<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> } else if (namespace != null) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> builder.setNamespace(namespace);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> } else if (tableName != null) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> builder.setTableName(ProtobufUtil.toProtoTableName(tableName));<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> return builder.setDescription(description).build();<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span>}<a name="line.104"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
