org.hbase.async

Class RowLockRequest

java.lang.Object

org.hbase.async.HBaseRpc

org.hbase.async.RowLockRequest

All Implemented Interfaces:

HBaseRpc.HasKey, HBaseRpc.HasTable

public final class RowLockRequest
extends HBaseRpc
implements HBaseRpc.HasTable, HBaseRpc.HasKey

Acquires an explicit row lock.

Row locks are no longer supported as of HBase 0.96. While they can still be used with earlier HBase versions, attempting to use them with HBase 0.95 and up will cause a UnsupportedOperationException to be thrown.

For a description of what row locks are, see RowLock.

A note on passing byte arrays in argument

None of the method that receive a byte[] in argument will copy it. For more info, please refer to the documentation of HBaseRpc.

A note on passing Strings in argument

All strings are assumed to use the platform's default charset.

Nested Class Summary

Nested classes/interfaces inherited from class org.hbase.async.HBaseRpc

HBaseRpc.HasFamily, HBaseRpc.HasKey, HBaseRpc.HasQualifier, HBaseRpc.HasQualifiers, HBaseRpc.HasTable, HBaseRpc.HasTimestamp, HBaseRpc.HasValue, HBaseRpc.HasValues

Constructor Summary

Constructors

Constructor and Description
RowLockRequest(byte[] table, byte[] key) Constructor.
RowLockRequest(String table, String key) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	key() Returns the row key this RPC is for.
byte[]	table() Returns the name of the table this RPC is for.

Methods inherited from class org.hbase.async.HBaseRpc

failfast, getTimeout, isProbe, isTraceRPC, setFailfast, setProbe, setTimeout, setTraceRPC, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RowLockRequest

public RowLockRequest(byte[] table,
              byte[] key)

Constructor. These byte arrays will NOT be copied.

Parameters:

table - The table containing the row to lock.

key - The key of the row to lock in that table.

RowLockRequest

public RowLockRequest(String table,
              String key)

Constructor.

Parameters:

table - The table containing the row to lock.

key - The key of the row to lock in that table.

Method Detail

table

public byte[] table()

Description copied from interface: HBaseRpc.HasTable

Returns the name of the table this RPC is for.

DO NOT MODIFY THE CONTENTS OF THE ARRAY RETURNED.

Specified by:

table in interface HBaseRpc.HasTable

Returns:

the name of the table this RPC is for.

key

public byte[] key()

Description copied from interface: HBaseRpc.HasKey

Returns the row key this RPC is for.

DO NOT MODIFY THE CONTENTS OF THE ARRAY RETURNED.

Specified by:

key in interface HBaseRpc.HasKey

Returns:

the row key this RPC is for.