org.apache.hadoop.hbase.client.locking

Class LockServiceClient

java.lang.Object

org.apache.hadoop.hbase.client.locking.LockServiceClient

@InterfaceAudience.LimitedPrivate(value="Tools")
 @InterfaceStability.Evolving
public class LockServiceClient
extends Object

Helper class to create "master locks" for namespaces, tables and regions. DEV-NOTE: At the moment this class is used only by the RS for MOB, to prevent other MOB compaction to conflict. The RS has already the stub of the LockService, so we have only one constructor that takes the LockService stub. If in the future we are going to use this in other places we should add a constructor that from conf or connection, creates the stub.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.hadoop.conf.Configuration	conf
private NonceGenerator	ng
private org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockService.BlockingInterface	stub

Constructor Summary

Constructors

Constructor and Description
LockServiceClient(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockService.BlockingInterface stub, NonceGenerator ng)

Method Summary

Modifier and Type	Method and Description
static org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockRequest	buildLockRequest(org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockType type, String namespace, TableName tableName, List<RegionInfo> regionInfos, String description, long nonceGroup, long nonce)
EntityLock	namespaceLock(String namespace, String description, Abortable abort) LocCreate a new EntityLock object to acquire exclusive lock on a namespace.
EntityLock	regionLock(List<RegionInfo> regionInfos, String description, Abortable abort) Create a new EntityLock object to acquire exclusive lock on multiple regions of same tables.
EntityLock	tableLock(TableName tableName, boolean exclusive, String description, Abortable abort) Create a new EntityLock object to acquire an exclusive or shared lock on a table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

stub

private final org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockService.BlockingInterface stub

conf

private final org.apache.hadoop.conf.Configuration conf

ng

private final NonceGenerator ng

Constructor Detail

LockServiceClient

public LockServiceClient(org.apache.hadoop.conf.Configuration conf,
                         org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockService.BlockingInterface stub,
                         NonceGenerator ng)

Method Detail

tableLock

public EntityLock tableLock(TableName tableName,
                            boolean exclusive,
                            String description,
                            Abortable abort)

Create a new EntityLock object to acquire an exclusive or shared lock on a table. Internally, the table namespace will also be locked in shared mode.

namespaceLock

public EntityLock namespaceLock(String namespace,
                                String description,
                                Abortable abort)

LocCreate a new EntityLock object to acquire exclusive lock on a namespace. Clients can not acquire shared locks on namespace.

regionLock

public EntityLock regionLock(List<RegionInfo> regionInfos,
                             String description,
                             Abortable abort)

Create a new EntityLock object to acquire exclusive lock on multiple regions of same tables. Internally, the table and its namespace will also be locked in shared mode.

buildLockRequest

public static org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockRequest buildLockRequest(org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockType type,
                                                                                                               String namespace,
                                                                                                               TableName tableName,
                                                                                                               List<RegionInfo> regionInfos,
                                                                                                               String description,
                                                                                                               long nonceGroup,
                                                                                                               long nonce)