blob: aa454cee17c9543c54d9439d741d2fdb2d39f26b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.client.locking, class: LockServiceClient">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client.locking;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.util.List;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.Abortable;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.NonceGenerator;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.RegionInfo;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceStability;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockRequest;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockService;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockType;</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35">/**</span>
<span class="source-line-no">036</span><span id="line-36"> * Helper class to create "master locks" for namespaces, tables and regions. DEV-NOTE: At the moment</span>
<span class="source-line-no">037</span><span id="line-37"> * this class is used only by the RS for MOB, to prevent other MOB compaction to conflict. The RS</span>
<span class="source-line-no">038</span><span id="line-38"> * has already the stub of the LockService, so we have only one constructor that takes the</span>
<span class="source-line-no">039</span><span id="line-39"> * LockService stub. If in the future we are going to use this in other places we should add a</span>
<span class="source-line-no">040</span><span id="line-40"> * constructor that from conf or connection, creates the stub.</span>
<span class="source-line-no">041</span><span id="line-41"> */</span>
<span class="source-line-no">042</span><span id="line-42">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.TOOLS)</span>
<span class="source-line-no">043</span><span id="line-43">@InterfaceStability.Evolving</span>
<span class="source-line-no">044</span><span id="line-44">public class LockServiceClient {</span>
<span class="source-line-no">045</span><span id="line-45"> private final LockService.BlockingInterface stub;</span>
<span class="source-line-no">046</span><span id="line-46"> private final Configuration conf;</span>
<span class="source-line-no">047</span><span id="line-47"> private final NonceGenerator ng;</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> public LockServiceClient(final Configuration conf, final LockService.BlockingInterface stub,</span>
<span class="source-line-no">050</span><span id="line-50"> final NonceGenerator ng) {</span>
<span class="source-line-no">051</span><span id="line-51"> this.conf = conf;</span>
<span class="source-line-no">052</span><span id="line-52"> this.stub = stub;</span>
<span class="source-line-no">053</span><span id="line-53"> this.ng = ng;</span>
<span class="source-line-no">054</span><span id="line-54"> }</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> /**</span>
<span class="source-line-no">057</span><span id="line-57"> * Create a new EntityLock object to acquire an exclusive or shared lock on a table. Internally,</span>
<span class="source-line-no">058</span><span id="line-58"> * the table namespace will also be locked in shared mode.</span>
<span class="source-line-no">059</span><span id="line-59"> */</span>
<span class="source-line-no">060</span><span id="line-60"> public EntityLock tableLock(final TableName tableName, final boolean exclusive,</span>
<span class="source-line-no">061</span><span id="line-61"> final String description, final Abortable abort) {</span>
<span class="source-line-no">062</span><span id="line-62"> LockRequest lockRequest = buildLockRequest(exclusive ? LockType.EXCLUSIVE : LockType.SHARED,</span>
<span class="source-line-no">063</span><span id="line-63"> tableName.getNameAsString(), null, null, description, ng.getNonceGroup(), ng.newNonce());</span>
<span class="source-line-no">064</span><span id="line-64"> return new EntityLock(conf, stub, lockRequest, abort);</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"></span>
<span class="source-line-no">067</span><span id="line-67"> /**</span>
<span class="source-line-no">068</span><span id="line-68"> * LocCreate a new EntityLock object to acquire exclusive lock on a namespace. Clients can not</span>
<span class="source-line-no">069</span><span id="line-69"> * acquire shared locks on namespace.</span>
<span class="source-line-no">070</span><span id="line-70"> */</span>
<span class="source-line-no">071</span><span id="line-71"> public EntityLock namespaceLock(String namespace, String description, Abortable abort) {</span>
<span class="source-line-no">072</span><span id="line-72"> LockRequest lockRequest = buildLockRequest(LockType.EXCLUSIVE, namespace, null, null,</span>
<span class="source-line-no">073</span><span id="line-73"> description, ng.getNonceGroup(), ng.newNonce());</span>
<span class="source-line-no">074</span><span id="line-74"> return new EntityLock(conf, stub, lockRequest, abort);</span>
<span class="source-line-no">075</span><span id="line-75"> }</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> /**</span>
<span class="source-line-no">078</span><span id="line-78"> * Create a new EntityLock object to acquire exclusive lock on multiple regions of same tables.</span>
<span class="source-line-no">079</span><span id="line-79"> * Internally, the table and its namespace will also be locked in shared mode.</span>
<span class="source-line-no">080</span><span id="line-80"> */</span>
<span class="source-line-no">081</span><span id="line-81"> public EntityLock regionLock(List&lt;RegionInfo&gt; regionInfos, String description, Abortable abort) {</span>
<span class="source-line-no">082</span><span id="line-82"> LockRequest lockRequest = buildLockRequest(LockType.EXCLUSIVE, null, null, regionInfos,</span>
<span class="source-line-no">083</span><span id="line-83"> description, ng.getNonceGroup(), ng.newNonce());</span>
<span class="source-line-no">084</span><span id="line-84"> return new EntityLock(conf, stub, lockRequest, abort);</span>
<span class="source-line-no">085</span><span id="line-85"> }</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> @InterfaceAudience.Private</span>
<span class="source-line-no">088</span><span id="line-88"> public static LockRequest buildLockRequest(final LockType type, final String namespace,</span>
<span class="source-line-no">089</span><span id="line-89"> final TableName tableName, final List&lt;RegionInfo&gt; regionInfos, final String description,</span>
<span class="source-line-no">090</span><span id="line-90"> final long nonceGroup, final long nonce) {</span>
<span class="source-line-no">091</span><span id="line-91"> final LockRequest.Builder builder =</span>
<span class="source-line-no">092</span><span id="line-92"> LockRequest.newBuilder().setLockType(type).setNonceGroup(nonceGroup).setNonce(nonce);</span>
<span class="source-line-no">093</span><span id="line-93"> if (regionInfos != null) {</span>
<span class="source-line-no">094</span><span id="line-94"> for (RegionInfo hri : regionInfos) {</span>
<span class="source-line-no">095</span><span id="line-95"> builder.addRegionInfo(ProtobufUtil.toRegionInfo(hri));</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"> } else if (namespace != null) {</span>
<span class="source-line-no">098</span><span id="line-98"> builder.setNamespace(namespace);</span>
<span class="source-line-no">099</span><span id="line-99"> } else if (tableName != null) {</span>
<span class="source-line-no">100</span><span id="line-100"> builder.setTableName(ProtobufUtil.toProtoTableName(tableName));</span>
<span class="source-line-no">101</span><span id="line-101"> }</span>
<span class="source-line-no">102</span><span id="line-102"> return builder.setDescription(description).build();</span>
<span class="source-line-no">103</span><span id="line-103"> }</span>
<span class="source-line-no">104</span><span id="line-104">}</span>
</pre>
</div>
</main>
</body>
</html>