org.apache.hadoop.hbase.protobuf

Class RequestConverter

java.lang.Object

org.apache.hadoop.hbase.protobuf.RequestConverter

@InterfaceAudience.Private
public final class RequestConverter
extends Object

Helper utility to build protocol buffer requests, or build components for protocol buffer requests.

Method Summary

Methods

Modifier and Type	Method and Description
static MasterProtos.AddColumnRequest	buildAddColumnRequest(TableName tableName, HColumnDescriptor column, long nonceGroup, long nonce) Create a protocol buffer AddColumnRequest
static MasterProtos.AssignRegionRequest	buildAssignRegionRequest(byte[] regionName) Create a protocol buffer AssignRegionRequest
static MasterProtos.BalanceRequest	buildBalanceRequest() Creates a protocol buffer BalanceRequest
static ClientProtos.BulkLoadHFileRequest	buildBulkLoadHFileRequest(List<Pair<byte[],String>> familyPaths, byte[] regionName, boolean assignSeqNum) Create a protocol buffer bulk load request
static MasterProtos.RunCatalogScanRequest	buildCatalogScanRequest() Creates a request for running a catalog scan
static AdminProtos.CloseRegionRequest	buildCloseRegionRequest(ServerName server, byte[] regionName, boolean transitionInZK) Create a CloseRegionRequest for a given region name
static AdminProtos.CloseRegionRequest	buildCloseRegionRequest(ServerName server, byte[] regionName, int versionOfClosingNode, ServerName destinationServer, boolean transitionInZK)
static AdminProtos.CloseRegionRequest	buildCloseRegionRequest(ServerName server, String encodedRegionName, boolean transitionInZK) Create a CloseRegionRequest for a given encoded region name
static AdminProtos.CompactRegionRequest	buildCompactRegionRequest(byte[] regionName, boolean major, byte[] family) Create a CompactRegionRequest for a given region name
static MasterProtos.CreateTableRequest	buildCreateTableRequest(HTableDescriptor hTableDesc, byte[][] splitKeys, long nonceGroup, long nonce) Creates a protocol buffer CreateTableRequest
static MasterProtos.DeleteColumnRequest	buildDeleteColumnRequest(TableName tableName, byte[] columnName, long nonceGroup, long nonce) Create a protocol buffer DeleteColumnRequest
static MasterProtos.DeleteTableRequest	buildDeleteTableRequest(TableName tableName, long nonceGroup, long nonce) Creates a protocol buffer DeleteTableRequest
static MasterProtos.DisableTableRequest	buildDisableTableRequest(TableName tableName, long nonceGroup, long nonce) Creates a protocol buffer DisableTableRequest
static MasterProtos.DispatchMergingRegionsRequest	buildDispatchMergingRegionsRequest(byte[] encodedNameOfRegionA, byte[] encodedNameOfRegionB, boolean forcible)
static MasterProtos.EnableCatalogJanitorRequest	buildEnableCatalogJanitorRequest(boolean enable) Creates a request for enabling/disabling the catalog janitor
static MasterProtos.EnableTableRequest	buildEnableTableRequest(TableName tableName, long nonceGroup, long nonce) Creates a protocol buffer EnableTableRequest
static AdminProtos.FlushRegionRequest	buildFlushRegionRequest(byte[] regionName) Create a protocol buffer FlushRegionRequest for a given region name
static AdminProtos.FlushRegionRequest	buildFlushRegionRequest(byte[] regionName, boolean writeFlushWALMarker) Create a protocol buffer FlushRegionRequest for a given region name
static MasterProtos.GetClusterStatusRequest	buildGetClusterStatusRequest() Creates a protocol buffer GetClusterStatusRequest
static RegionServerStatusProtos.GetLastFlushedSequenceIdRequest	buildGetLastFlushedSequenceIdRequest(byte[] regionName) Creates a request for querying the master the last flushed sequence Id for a region
static AdminProtos.GetOnlineRegionRequest	buildGetOnlineRegionRequest() Create a protocol buffer GetOnlineRegionRequest
static AdminProtos.GetRegionInfoRequest	buildGetRegionInfoRequest(byte[] regionName) Create a protocol buffer GetRegionInfoRequest for a given region name
static AdminProtos.GetRegionInfoRequest	buildGetRegionInfoRequest(byte[] regionName, boolean includeCompactionState) Create a protocol buffer GetRegionInfoRequest for a given region name
static ClientProtos.GetRequest	buildGetRequest(byte[] regionName, Get get) Create a protocol buffer GetRequest for a client Get
static ClientProtos.GetRequest	buildGetRowOrBeforeRequest(byte[] regionName, byte[] row, byte[] family) Create a new protocol buffer GetRequest to get a row, all columns in a family.
static MasterProtos.GetSchemaAlterStatusRequest	buildGetSchemaAlterStatusRequest(TableName tableName) Creates a protocol buffer GetSchemaAlterStatusRequest
static AdminProtos.GetServerInfoRequest	buildGetServerInfoRequest() Create a new GetServerInfoRequest
static AdminProtos.GetStoreFileRequest	buildGetStoreFileRequest(byte[] regionName, byte[] family) Create a protocol buffer GetStoreFileRequest for a given region name
static MasterProtos.GetTableDescriptorsRequest	buildGetTableDescriptorsRequest(List<TableName> tableNames) Creates a protocol buffer GetTableDescriptorsRequest
static MasterProtos.GetTableDescriptorsRequest	buildGetTableDescriptorsRequest(Pattern pattern, boolean includeSysTables) Creates a protocol buffer GetTableDescriptorsRequest
static MasterProtos.GetTableDescriptorsRequest	buildGetTableDescriptorsRequest(TableName tableName) Creates a protocol buffer GetTableDescriptorsRequest for a single table
static MasterProtos.GetTableNamesRequest	buildGetTableNamesRequest(Pattern pattern, boolean includeSysTables) Creates a protocol buffer GetTableNamesRequest
static AccessControlProtos.GrantRequest	buildGrantRequest(String username, AccessControlProtos.Permission.Action... actions) Create a request to grant user permissions.
static AccessControlProtos.GrantRequest	buildGrantRequest(String username, String namespace, AccessControlProtos.Permission.Action... actions) Create a request to grant user permissions.
static AccessControlProtos.GrantRequest	buildGrantRequest(String username, TableName tableName, byte[] family, byte[] qualifier, AccessControlProtos.Permission.Action... actions) Create a request to grant user permissions.
static ClientProtos.MutateRequest	buildIncrementRequest(byte[] regionName, byte[] row, byte[] family, byte[] qualifier, long amount, Durability durability, long nonceGroup, long nonce) Create a protocol buffer MutateRequest for a client increment
static MasterProtos.IsBalancerEnabledRequest	buildIsBalancerEnabledRequest() Creates a protocol buffer IsBalancerEnabledRequest
static MasterProtos.IsCatalogJanitorEnabledRequest	buildIsCatalogJanitorEnabledRequest() Creates a request for querying the master whether the catalog janitor is enabled
static MasterProtos.IsMasterRunningRequest	buildIsMasterRunningRequest() Creates a protocol buffer IsMasterRunningRequest
static AdminProtos.MergeRegionsRequest	buildMergeRegionsRequest(byte[] regionA, byte[] regionB, boolean forcible) Create a MergeRegionsRequest for the given regions
static MasterProtos.ModifyColumnRequest	buildModifyColumnRequest(TableName tableName, HColumnDescriptor column, long nonceGroup, long nonce) Create a protocol buffer ModifyColumnRequest
static MasterProtos.ModifyTableRequest	buildModifyTableRequest(TableName tableName, HTableDescriptor hTableDesc, long nonceGroup, long nonce) Creates a protocol buffer ModifyTableRequest
static MasterProtos.MoveRegionRequest	buildMoveRegionRequest(byte[] encodedRegionName, byte[] destServerName) Create a protocol buffer MoveRegionRequest
static ClientProtos.MutateRequest	buildMutateRequest(byte[] regionName, Append append, long nonceGroup, long nonce) Create a protocol buffer MutateRequest for an append
static ClientProtos.MutateRequest	buildMutateRequest(byte[] regionName, byte[] row, byte[] family, byte[] qualifier, ByteArrayComparable comparator, HBaseProtos.CompareType compareType, Delete delete) Create a protocol buffer MutateRequest for a conditioned delete
static ClientProtos.MutateRequest	buildMutateRequest(byte[] regionName, byte[] row, byte[] family, byte[] qualifier, ByteArrayComparable comparator, HBaseProtos.CompareType compareType, Put put) Create a protocol buffer MutateRequest for a conditioned put
static ClientProtos.MultiRequest	buildMutateRequest(byte[] regionName, byte[] row, byte[] family, byte[] qualifier, ByteArrayComparable comparator, HBaseProtos.CompareType compareType, RowMutations rowMutations) Create a protocol buffer MutateRequest for conditioned row mutations
static ClientProtos.MutateRequest	buildMutateRequest(byte[] regionName, Delete delete) Create a protocol buffer MutateRequest for a delete
static ClientProtos.MutateRequest	buildMutateRequest(byte[] regionName, Increment increment, long nonceGroup, long nonce) Create a protocol buffer MutateRequest for a client increment
static ClientProtos.MutateRequest	buildMutateRequest(byte[] regionName, Put put) Create a protocol buffer MutateRequest for a put
static <R> ClientProtos.RegionAction.Builder	buildNoDataRegionAction(byte[] regionName, List<Action<R>> actions, List<CellScannable> cells, ClientProtos.RegionAction.Builder regionActionBuilder, ClientProtos.Action.Builder actionBuilder, ClientProtos.MutationProto.Builder mutationBuilder) Create a protocol buffer multirequest with NO data for a list of actions (data is carried otherwise than via protobuf).
static ClientProtos.RegionAction.Builder	buildNoDataRegionAction(byte[] regionName, RowMutations rowMutations, List<CellScannable> cells, ClientProtos.RegionAction.Builder regionActionBuilder, ClientProtos.Action.Builder actionBuilder, ClientProtos.MutationProto.Builder mutationBuilder) Create a protocol buffer MultiRequest for row mutations that does not hold data.
static MasterProtos.OfflineRegionRequest	buildOfflineRegionRequest(byte[] regionName) Creates a protocol buffer OfflineRegionRequest
static AdminProtos.OpenRegionRequest	buildOpenRegionRequest(ServerName server, HRegionInfo region, int versionOfOfflineNode, List<ServerName> favoredNodes, Boolean openForReplay) Create a protocol buffer OpenRegionRequest for a given region
static AdminProtos.OpenRegionRequest	buildOpenRegionRequest(ServerName server, List<Triple<HRegionInfo,Integer,List<ServerName>>> regionOpenInfos, Boolean openForReplay) Create a protocol buffer OpenRegionRequest to open a list of regions
static <R> ClientProtos.RegionAction.Builder	buildRegionAction(byte[] regionName, List<Action<R>> actions, ClientProtos.RegionAction.Builder regionActionBuilder, ClientProtos.Action.Builder actionBuilder, ClientProtos.MutationProto.Builder mutationBuilder) Create a protocol buffer multi request for a list of actions.
static ClientProtos.RegionAction.Builder	buildRegionAction(byte[] regionName, RowMutations rowMutations) Create a protocol buffer MultiRequest for row mutations.
static HBaseProtos.RegionSpecifier	buildRegionSpecifier(HBaseProtos.RegionSpecifier.RegionSpecifierType type, byte[] value) Convert a byte array to a protocol buffer RegionSpecifier
static AccessControlProtos.RevokeRequest	buildRevokeRequest(String username, AccessControlProtos.Permission.Action... actions) Create a request to revoke user permissions.
static AccessControlProtos.RevokeRequest	buildRevokeRequest(String username, String namespace, AccessControlProtos.Permission.Action... actions) Create a request to revoke user permissions.
static AccessControlProtos.RevokeRequest	buildRevokeRequest(String username, TableName tableName, byte[] family, byte[] qualifier, AccessControlProtos.Permission.Action... actions) Create a request to revoke user permissions.
static AdminProtos.RollWALWriterRequest	buildRollWALWriterRequest() Create a new RollWALWriterRequest
static ClientProtos.ScanRequest	buildScanRequest(byte[] regionName, Scan scan, int numberOfRows, boolean closeScanner) Create a protocol buffer ScanRequest for a client Scan
static ClientProtos.ScanRequest	buildScanRequest(long scannerId, int numberOfRows, boolean closeScanner) Create a protocol buffer ScanRequest for a scanner id
static ClientProtos.ScanRequest	buildScanRequest(long scannerId, int numberOfRows, boolean closeScanner, long nextCallSeq, boolean renew) Create a protocol buffer ScanRequest for a scanner id
static MasterProtos.SetBalancerRunningRequest	buildSetBalancerRunningRequest(boolean on, boolean synchronous) Creates a protocol buffer SetBalancerRunningRequest
static AdminProtos.SplitRegionRequest	buildSplitRegionRequest(byte[] regionName, byte[] splitPoint) Create a SplitRegionRequest for a given region name
static AdminProtos.StopServerRequest	buildStopServerRequest(String reason) Create a new StopServerRequest
static MasterProtos.TruncateTableRequest	buildTruncateTableRequest(TableName tableName, boolean preserveSplits, long nonceGroup, long nonce) Creates a protocol buffer TruncateTableRequest
static MasterProtos.UnassignRegionRequest	buildUnassignRegionRequest(byte[] regionName, boolean force) Creates a protocol buffer UnassignRegionRequest
static AdminProtos.UpdateFavoredNodesRequest	buildUpdateFavoredNodesRequest(List<Pair<HRegionInfo,List<ServerName>>> updateRegionInfos) Create a protocol buffer UpdateFavoredNodesRequest to update a list of favorednode mappings
static AdminProtos.WarmupRegionRequest	buildWarmupRegionRequest(HRegionInfo regionInfo) Create a WarmupRegionRequest for a given region name

Methods inherited from class java.lang.Object

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

Method Detail

buildGetRowOrBeforeRequest

public static ClientProtos.GetRequest buildGetRowOrBeforeRequest(byte[] regionName,
                                                 byte[] row,
                                                 byte[] family)

Create a new protocol buffer GetRequest to get a row, all columns in a family. If there is no such row, return the closest row before it.

Parameters:

regionName - the name of the region to get

row - the row to get

family - the column family to get should return the immediate row before

Returns:

a protocol buffer GetReuqest

buildGetRequest

public static ClientProtos.GetRequest buildGetRequest(byte[] regionName,
                                      Get get)
                                               throws IOException

Create a protocol buffer GetRequest for a client Get

Parameters:

regionName - the name of the region to get

get - the client Get

Returns:

a protocol buffer GetRequest

Throws:

IOException

buildIncrementRequest

public static ClientProtos.MutateRequest buildIncrementRequest(byte[] regionName,
                                               byte[] row,
                                               byte[] family,
                                               byte[] qualifier,
                                               long amount,
                                               Durability durability,
                                               long nonceGroup,
                                               long nonce)

Create a protocol buffer MutateRequest for a client increment

Parameters:

regionName -

row -

family -

qualifier -

amount -

durability -

Returns:

a mutate request

buildMutateRequest

public static ClientProtos.MutateRequest buildMutateRequest(byte[] regionName,
                                            byte[] row,
                                            byte[] family,
                                            byte[] qualifier,
                                            ByteArrayComparable comparator,
                                            HBaseProtos.CompareType compareType,
                                            Put put)
                                                     throws IOException

Create a protocol buffer MutateRequest for a conditioned put

Parameters:

regionName -

row -

family -

qualifier -

comparator -

compareType -

put -

Returns:

a mutate request

Throws:

IOException

buildMutateRequest

public static ClientProtos.MutateRequest buildMutateRequest(byte[] regionName,
                                            byte[] row,
                                            byte[] family,
                                            byte[] qualifier,
                                            ByteArrayComparable comparator,
                                            HBaseProtos.CompareType compareType,
                                            Delete delete)
                                                     throws IOException

Create a protocol buffer MutateRequest for a conditioned delete

Parameters:

regionName -

row -

family -

qualifier -

comparator -

compareType -

delete -

Returns:

a mutate request

Throws:

IOException

buildMutateRequest

public static ClientProtos.MultiRequest buildMutateRequest(byte[] regionName,
                                           byte[] row,
                                           byte[] family,
                                           byte[] qualifier,
                                           ByteArrayComparable comparator,
                                           HBaseProtos.CompareType compareType,
                                           RowMutations rowMutations)
                                                    throws IOException

Create a protocol buffer MutateRequest for conditioned row mutations

Parameters:

regionName -

row -

family -

qualifier -

comparator -

compareType -

rowMutations -

Returns:

a mutate request

Throws:

IOException

buildMutateRequest

public static ClientProtos.MutateRequest buildMutateRequest(byte[] regionName,
                                            Put put)
                                                     throws IOException

Create a protocol buffer MutateRequest for a put

Parameters:

regionName -

put -

Returns:

a mutate request

Throws:

IOException

buildMutateRequest

public static ClientProtos.MutateRequest buildMutateRequest(byte[] regionName,
                                            Append append,
                                            long nonceGroup,
                                            long nonce)
                                                     throws IOException

Create a protocol buffer MutateRequest for an append

Parameters:

regionName -

append -

Returns:

a mutate request

Throws:

IOException

buildMutateRequest

public static ClientProtos.MutateRequest buildMutateRequest(byte[] regionName,
                                            Increment increment,
                                            long nonceGroup,
                                            long nonce)

Create a protocol buffer MutateRequest for a client increment

Parameters:

regionName -

increment -

Returns:

a mutate request

buildMutateRequest

public static ClientProtos.MutateRequest buildMutateRequest(byte[] regionName,
                                            Delete delete)
                                                     throws IOException

Create a protocol buffer MutateRequest for a delete

Parameters:

regionName -

delete -

Returns:

a mutate request

Throws:

IOException

buildRegionAction

public static ClientProtos.RegionAction.Builder buildRegionAction(byte[] regionName,
                                                  RowMutations rowMutations)
                                                           throws IOException

Create a protocol buffer MultiRequest for row mutations. Does not propagate Action absolute position. Does not set atomic action on the created RegionAtomic. Caller should do that if wanted.

Parameters:

regionName -

rowMutations -

Returns:

a data-laden RegionMutation.Builder

Throws:

IOException

buildNoDataRegionAction

public static ClientProtos.RegionAction.Builder buildNoDataRegionAction(byte[] regionName,
                                                        RowMutations rowMutations,
                                                        List<CellScannable> cells,
                                                        ClientProtos.RegionAction.Builder regionActionBuilder,
                                                        ClientProtos.Action.Builder actionBuilder,
                                                        ClientProtos.MutationProto.Builder mutationBuilder)
                                                                 throws IOException

Create a protocol buffer MultiRequest for row mutations that does not hold data. Data/Cells are carried outside of protobuf. Return references to the Cells in cells param. Does not propagate Action absolute position. Does not set atomic action on the created RegionAtomic. Caller should do that if wanted.

Parameters:

regionName -

rowMutations -

cells - Return in here a list of Cells as CellIterable.

Returns:

a region mutation minus data

Throws:

IOException

buildScanRequest

public static ClientProtos.ScanRequest buildScanRequest(byte[] regionName,
                                        Scan scan,
                                        int numberOfRows,
                                        boolean closeScanner)
                                                 throws IOException

Create a protocol buffer ScanRequest for a client Scan

Parameters:

regionName -

scan -

numberOfRows -

closeScanner -

Returns:

a scan request

Throws:

IOException

buildScanRequest

public static ClientProtos.ScanRequest buildScanRequest(long scannerId,
                                        int numberOfRows,
                                        boolean closeScanner)

Create a protocol buffer ScanRequest for a scanner id

Parameters:

scannerId -

numberOfRows -

closeScanner -

Returns:

a scan request

buildScanRequest

public static ClientProtos.ScanRequest buildScanRequest(long scannerId,
                                        int numberOfRows,
                                        boolean closeScanner,
                                        long nextCallSeq,
                                        boolean renew)

Create a protocol buffer ScanRequest for a scanner id

Parameters:

scannerId -

numberOfRows -

closeScanner -

nextCallSeq -

Returns:

a scan request

buildBulkLoadHFileRequest

public static ClientProtos.BulkLoadHFileRequest buildBulkLoadHFileRequest(List<Pair<byte[],String>> familyPaths,
                                                          byte[] regionName,
                                                          boolean assignSeqNum)

Create a protocol buffer bulk load request

Parameters:

familyPaths -

regionName -

assignSeqNum -

Returns:

a bulk load request

buildRegionAction

public static <R> ClientProtos.RegionAction.Builder buildRegionAction(byte[] regionName,
                                                      List<Action<R>> actions,
                                                      ClientProtos.RegionAction.Builder regionActionBuilder,
                                                      ClientProtos.Action.Builder actionBuilder,
                                                      ClientProtos.MutationProto.Builder mutationBuilder)
                                                           throws IOException

Create a protocol buffer multi request for a list of actions. Propagates Actions original index.

Parameters:

regionName -

actions -

Returns:

a multi request

Throws:

IOException

buildNoDataRegionAction

public static <R> ClientProtos.RegionAction.Builder buildNoDataRegionAction(byte[] regionName,
                                                            List<Action<R>> actions,
                                                            List<CellScannable> cells,
                                                            ClientProtos.RegionAction.Builder regionActionBuilder,
                                                            ClientProtos.Action.Builder actionBuilder,
                                                            ClientProtos.MutationProto.Builder mutationBuilder)
                                                                 throws IOException

Create a protocol buffer multirequest with NO data for a list of actions (data is carried otherwise than via protobuf). This means it just notes attributes, whether to write the WAL, etc., and the presence in protobuf serves as place holder for the data which is coming along otherwise. Note that Get is different. It does not contain 'data' and is always carried by protobuf. We return references to the data by adding them to the passed in data param.

Propagates Actions original index.

Parameters:

regionName -

actions -

cells - Place to stuff references to actual data.

Returns:

a multi request that does not carry any data.

Throws:

IOException

buildGetRegionInfoRequest

public static AdminProtos.GetRegionInfoRequest buildGetRegionInfoRequest(byte[] regionName)

Create a protocol buffer GetRegionInfoRequest for a given region name

Parameters:

regionName - the name of the region to get info

Returns:

a protocol buffer GetRegionInfoRequest

buildGetRegionInfoRequest

public static AdminProtos.GetRegionInfoRequest buildGetRegionInfoRequest(byte[] regionName,
                                                         boolean includeCompactionState)

Create a protocol buffer GetRegionInfoRequest for a given region name

Parameters:

regionName - the name of the region to get info

includeCompactionState - indicate if the compaction state is requested

Returns:

a protocol buffer GetRegionInfoRequest

buildGetStoreFileRequest

public static AdminProtos.GetStoreFileRequest buildGetStoreFileRequest(byte[] regionName,
                                                       byte[] family)

Create a protocol buffer GetStoreFileRequest for a given region name

Parameters:

regionName - the name of the region to get info

family - the family to get store file list

Returns:

a protocol buffer GetStoreFileRequest

buildGetOnlineRegionRequest

public static AdminProtos.GetOnlineRegionRequest buildGetOnlineRegionRequest()

Create a protocol buffer GetOnlineRegionRequest

Returns:

a protocol buffer GetOnlineRegionRequest

buildFlushRegionRequest

public static AdminProtos.FlushRegionRequest buildFlushRegionRequest(byte[] regionName)

Create a protocol buffer FlushRegionRequest for a given region name

Parameters:

regionName - the name of the region to get info

Returns:

a protocol buffer FlushRegionRequest

buildFlushRegionRequest

public static AdminProtos.FlushRegionRequest buildFlushRegionRequest(byte[] regionName,
                                                     boolean writeFlushWALMarker)

Create a protocol buffer FlushRegionRequest for a given region name

Parameters:

regionName - the name of the region to get info

Returns:

a protocol buffer FlushRegionRequest

buildOpenRegionRequest

public static AdminProtos.OpenRegionRequest buildOpenRegionRequest(ServerName server,
                                                   List<Triple<HRegionInfo,Integer,List<ServerName>>> regionOpenInfos,
                                                   Boolean openForReplay)

Create a protocol buffer OpenRegionRequest to open a list of regions

Parameters:

server - the serverName for the RPC

regionOpenInfos - info of a list of regions to open

openForReplay -

Returns:

a protocol buffer OpenRegionRequest

buildOpenRegionRequest

public static AdminProtos.OpenRegionRequest buildOpenRegionRequest(ServerName server,
                                                   HRegionInfo region,
                                                   int versionOfOfflineNode,
                                                   List<ServerName> favoredNodes,
                                                   Boolean openForReplay)

Create a protocol buffer OpenRegionRequest for a given region

Parameters:

server - the serverName for the RPC

region - the region to open

versionOfOfflineNode - that needs to be present in the offline node

favoredNodes -

openForReplay -

Returns:

a protocol buffer OpenRegionRequest

buildUpdateFavoredNodesRequest

public static AdminProtos.UpdateFavoredNodesRequest buildUpdateFavoredNodesRequest(List<Pair<HRegionInfo,List<ServerName>>> updateRegionInfos)

Create a protocol buffer UpdateFavoredNodesRequest to update a list of favorednode mappings

Parameters:

updateRegionInfos -

Returns:

a protocol buffer UpdateFavoredNodesRequest

buildCloseRegionRequest

public static AdminProtos.CloseRegionRequest buildCloseRegionRequest(ServerName server,
                                                     byte[] regionName,
                                                     boolean transitionInZK)

Create a CloseRegionRequest for a given region name

Parameters:

regionName - the name of the region to close

transitionInZK - indicator if to transition in ZK

Returns:

a CloseRegionRequest

buildCloseRegionRequest

public static AdminProtos.CloseRegionRequest buildCloseRegionRequest(ServerName server,
                                                     byte[] regionName,
                                                     int versionOfClosingNode,
                                                     ServerName destinationServer,
                                                     boolean transitionInZK)

buildWarmupRegionRequest

public static AdminProtos.WarmupRegionRequest buildWarmupRegionRequest(HRegionInfo regionInfo)

Create a WarmupRegionRequest for a given region name

Parameters:

regionInfo - Region we are warming up

buildCloseRegionRequest

public static AdminProtos.CloseRegionRequest buildCloseRegionRequest(ServerName server,
                                                     String encodedRegionName,
                                                     boolean transitionInZK)

Create a CloseRegionRequest for a given encoded region name

Parameters:

encodedRegionName - the name of the region to close

transitionInZK - indicator if to transition in ZK

Returns:

a CloseRegionRequest

buildSplitRegionRequest

public static AdminProtos.SplitRegionRequest buildSplitRegionRequest(byte[] regionName,
                                                     byte[] splitPoint)

Create a SplitRegionRequest for a given region name

Parameters:

regionName - the name of the region to split

splitPoint - the split point

Returns:

a SplitRegionRequest

buildMergeRegionsRequest

public static AdminProtos.MergeRegionsRequest buildMergeRegionsRequest(byte[] regionA,
                                                       byte[] regionB,
                                                       boolean forcible)

Create a MergeRegionsRequest for the given regions

Parameters:

regionA - name of region a

regionB - name of region b

forcible - true if it is a compulsory merge

Returns:

a MergeRegionsRequest

buildCompactRegionRequest

public static AdminProtos.CompactRegionRequest buildCompactRegionRequest(byte[] regionName,
                                                         boolean major,
                                                         byte[] family)

Create a CompactRegionRequest for a given region name

Parameters:

regionName - the name of the region to get info

major - indicator if it is a major compaction

Returns:

a CompactRegionRequest

buildRollWALWriterRequest

public static AdminProtos.RollWALWriterRequest buildRollWALWriterRequest()

Create a new RollWALWriterRequest

Returns:

a ReplicateWALEntryRequest

buildGetServerInfoRequest

public static AdminProtos.GetServerInfoRequest buildGetServerInfoRequest()

Create a new GetServerInfoRequest

Returns:

a GetServerInfoRequest

buildStopServerRequest

public static AdminProtos.StopServerRequest buildStopServerRequest(String reason)

Create a new StopServerRequest

Parameters:

reason - the reason to stop the server

Returns:

a StopServerRequest

buildRegionSpecifier

public static HBaseProtos.RegionSpecifier buildRegionSpecifier(HBaseProtos.RegionSpecifier.RegionSpecifierType type,
                                               byte[] value)

Convert a byte array to a protocol buffer RegionSpecifier

Parameters:

type - the region specifier type

value - the region specifier byte array value

Returns:

a protocol buffer RegionSpecifier

buildAddColumnRequest

public static MasterProtos.AddColumnRequest buildAddColumnRequest(TableName tableName,
                                                  HColumnDescriptor column,
                                                  long nonceGroup,
                                                  long nonce)

Create a protocol buffer AddColumnRequest

Parameters:

tableName -

column -

Returns:

an AddColumnRequest

buildDeleteColumnRequest

public static MasterProtos.DeleteColumnRequest buildDeleteColumnRequest(TableName tableName,
                                                        byte[] columnName,
                                                        long nonceGroup,
                                                        long nonce)

Create a protocol buffer DeleteColumnRequest

Parameters:

tableName -

columnName -

Returns:

a DeleteColumnRequest

buildModifyColumnRequest

public static MasterProtos.ModifyColumnRequest buildModifyColumnRequest(TableName tableName,
                                                        HColumnDescriptor column,
                                                        long nonceGroup,
                                                        long nonce)

Create a protocol buffer ModifyColumnRequest

Parameters:

tableName -

column -

Returns:

an ModifyColumnRequest

buildMoveRegionRequest

public static MasterProtos.MoveRegionRequest buildMoveRegionRequest(byte[] encodedRegionName,
                                                    byte[] destServerName)
                                                             throws DeserializationException

Create a protocol buffer MoveRegionRequest

Parameters:

encodedRegionName -

destServerName -

Returns:

A MoveRegionRequest

Throws:

DeserializationException

buildDispatchMergingRegionsRequest

public static MasterProtos.DispatchMergingRegionsRequest buildDispatchMergingRegionsRequest(byte[] encodedNameOfRegionA,
                                                                            byte[] encodedNameOfRegionB,
                                                                            boolean forcible)
                                                                                     throws DeserializationException

Throws:

DeserializationException

buildAssignRegionRequest

public static MasterProtos.AssignRegionRequest buildAssignRegionRequest(byte[] regionName)

Create a protocol buffer AssignRegionRequest

Parameters:

regionName -

Returns:

an AssignRegionRequest

buildUnassignRegionRequest

public static MasterProtos.UnassignRegionRequest buildUnassignRegionRequest(byte[] regionName,
                                                            boolean force)

Creates a protocol buffer UnassignRegionRequest

Parameters:

regionName -

force -

Returns:

an UnassignRegionRequest

buildOfflineRegionRequest

public static MasterProtos.OfflineRegionRequest buildOfflineRegionRequest(byte[] regionName)

Creates a protocol buffer OfflineRegionRequest

Parameters:

regionName -

Returns:

an OfflineRegionRequest

buildDeleteTableRequest

public static MasterProtos.DeleteTableRequest buildDeleteTableRequest(TableName tableName,
                                                      long nonceGroup,
                                                      long nonce)

Creates a protocol buffer DeleteTableRequest

Parameters:

tableName -

Returns:

a DeleteTableRequest

buildTruncateTableRequest

public static MasterProtos.TruncateTableRequest buildTruncateTableRequest(TableName tableName,
                                                          boolean preserveSplits,
                                                          long nonceGroup,
                                                          long nonce)

Creates a protocol buffer TruncateTableRequest

Parameters:

tableName - name of table to truncate

preserveSplits - True if the splits should be preserved

Returns:

a TruncateTableRequest

buildEnableTableRequest

public static MasterProtos.EnableTableRequest buildEnableTableRequest(TableName tableName,
                                                      long nonceGroup,
                                                      long nonce)

Creates a protocol buffer EnableTableRequest

Parameters:

tableName -

Returns:

an EnableTableRequest

buildDisableTableRequest

public static MasterProtos.DisableTableRequest buildDisableTableRequest(TableName tableName,
                                                        long nonceGroup,
                                                        long nonce)

Creates a protocol buffer DisableTableRequest

Parameters:

tableName -

Returns:

a DisableTableRequest

buildCreateTableRequest

public static MasterProtos.CreateTableRequest buildCreateTableRequest(HTableDescriptor hTableDesc,
                                                      byte[][] splitKeys,
                                                      long nonceGroup,
                                                      long nonce)

Creates a protocol buffer CreateTableRequest

Parameters:

hTableDesc -

splitKeys -

Returns:

a CreateTableRequest

buildModifyTableRequest

public static MasterProtos.ModifyTableRequest buildModifyTableRequest(TableName tableName,
                                                      HTableDescriptor hTableDesc,
                                                      long nonceGroup,
                                                      long nonce)

Creates a protocol buffer ModifyTableRequest

Parameters:

tableName -

hTableDesc -

Returns:

a ModifyTableRequest

buildGetSchemaAlterStatusRequest

public static MasterProtos.GetSchemaAlterStatusRequest buildGetSchemaAlterStatusRequest(TableName tableName)

Creates a protocol buffer GetSchemaAlterStatusRequest

Parameters:

tableName -

Returns:

a GetSchemaAlterStatusRequest

buildGetTableDescriptorsRequest

public static MasterProtos.GetTableDescriptorsRequest buildGetTableDescriptorsRequest(List<TableName> tableNames)

Creates a protocol buffer GetTableDescriptorsRequest

Parameters:

tableNames -

Returns:

a GetTableDescriptorsRequest

buildGetTableDescriptorsRequest

public static MasterProtos.GetTableDescriptorsRequest buildGetTableDescriptorsRequest(Pattern pattern,
                                                                      boolean includeSysTables)

Creates a protocol buffer GetTableDescriptorsRequest

Parameters:

pattern - The compiled regular expression to match against

includeSysTables - False to match only against userspace tables

Returns:

a GetTableDescriptorsRequest

buildGetTableNamesRequest

public static MasterProtos.GetTableNamesRequest buildGetTableNamesRequest(Pattern pattern,
                                                          boolean includeSysTables)

Creates a protocol buffer GetTableNamesRequest

Parameters:

pattern - The compiled regular expression to match against

includeSysTables - False to match only against userspace tables

Returns:

a GetTableNamesRequest

buildGetTableDescriptorsRequest

public static MasterProtos.GetTableDescriptorsRequest buildGetTableDescriptorsRequest(TableName tableName)

Creates a protocol buffer GetTableDescriptorsRequest for a single table

Parameters:

tableName - the table name

Returns:

a GetTableDescriptorsRequest

buildIsMasterRunningRequest

public static MasterProtos.IsMasterRunningRequest buildIsMasterRunningRequest()

Creates a protocol buffer IsMasterRunningRequest

Returns:

a IsMasterRunningRequest

buildBalanceRequest

public static MasterProtos.BalanceRequest buildBalanceRequest()

Creates a protocol buffer BalanceRequest

Returns:

a BalanceRequest

buildSetBalancerRunningRequest

public static MasterProtos.SetBalancerRunningRequest buildSetBalancerRunningRequest(boolean on,
                                                                    boolean synchronous)

Creates a protocol buffer SetBalancerRunningRequest

Parameters:

on -

synchronous -

Returns:

a SetBalancerRunningRequest

buildIsBalancerEnabledRequest

public static MasterProtos.IsBalancerEnabledRequest buildIsBalancerEnabledRequest()

Creates a protocol buffer IsBalancerEnabledRequest

Returns:

a IsBalancerEnabledRequest

buildGetClusterStatusRequest

public static MasterProtos.GetClusterStatusRequest buildGetClusterStatusRequest()

Creates a protocol buffer GetClusterStatusRequest

Returns:

A GetClusterStatusRequest

buildCatalogScanRequest

public static MasterProtos.RunCatalogScanRequest buildCatalogScanRequest()

Creates a request for running a catalog scan

Returns:

A MasterProtos.RunCatalogScanRequest

buildEnableCatalogJanitorRequest

public static MasterProtos.EnableCatalogJanitorRequest buildEnableCatalogJanitorRequest(boolean enable)

Creates a request for enabling/disabling the catalog janitor

Returns:

A MasterProtos.EnableCatalogJanitorRequest

buildIsCatalogJanitorEnabledRequest

public static MasterProtos.IsCatalogJanitorEnabledRequest buildIsCatalogJanitorEnabledRequest()

Creates a request for querying the master whether the catalog janitor is enabled

Returns:

A MasterProtos.IsCatalogJanitorEnabledRequest

buildGetLastFlushedSequenceIdRequest

public static RegionServerStatusProtos.GetLastFlushedSequenceIdRequest buildGetLastFlushedSequenceIdRequest(byte[] regionName)

Creates a request for querying the master the last flushed sequence Id for a region

Parameters:

regionName -

Returns:

A RegionServerStatusProtos.GetLastFlushedSequenceIdRequest

buildGrantRequest

public static AccessControlProtos.GrantRequest buildGrantRequest(String username,
                                                 AccessControlProtos.Permission.Action... actions)

Create a request to grant user permissions.

Parameters:

username - the short user name who to grant permissions

actions - the permissions to be granted

Returns:

A AccessControlProtos GrantRequest

buildGrantRequest

public static AccessControlProtos.GrantRequest buildGrantRequest(String username,
                                                 TableName tableName,
                                                 byte[] family,
                                                 byte[] qualifier,
                                                 AccessControlProtos.Permission.Action... actions)

Create a request to grant user permissions.

Parameters:

username - the short user name who to grant permissions

tableName - optional table name the permissions apply

family - optional column family

qualifier - optional qualifier

actions - the permissions to be granted

Returns:

A AccessControlProtos GrantRequest

buildGrantRequest

public static AccessControlProtos.GrantRequest buildGrantRequest(String username,
                                                 String namespace,
                                                 AccessControlProtos.Permission.Action... actions)

Create a request to grant user permissions.

Parameters:

username - the short user name who to grant permissions

namespace - optional table name the permissions apply

actions - the permissions to be granted

Returns:

A AccessControlProtos GrantRequest

buildRevokeRequest

public static AccessControlProtos.RevokeRequest buildRevokeRequest(String username,
                                                   AccessControlProtos.Permission.Action... actions)

Create a request to revoke user permissions.

Parameters:

username - the short user name whose permissions to be revoked

actions - the permissions to be revoked

Returns:

A AccessControlProtos RevokeRequest

buildRevokeRequest

public static AccessControlProtos.RevokeRequest buildRevokeRequest(String username,
                                                   TableName tableName,
                                                   byte[] family,
                                                   byte[] qualifier,
                                                   AccessControlProtos.Permission.Action... actions)

Create a request to revoke user permissions.

Parameters:

username - the short user name whose permissions to be revoked

tableName - optional table name the permissions apply

family - optional column family

qualifier - optional qualifier

actions - the permissions to be revoked

Returns:

A AccessControlProtos RevokeRequest

buildRevokeRequest

public static AccessControlProtos.RevokeRequest buildRevokeRequest(String username,
                                                   String namespace,
                                                   AccessControlProtos.Permission.Action... actions)

Create a request to revoke user permissions.

Parameters:

username - the short user name whose permissions to be revoked

namespace - optional table name the permissions apply

actions - the permissions to be revoked

Returns:

A AccessControlProtos RevokeRequest