org.apache.hadoop.hbase.shaded.protobuf

Class ResponseConverter

java.lang.Object

org.apache.hadoop.hbase.shaded.protobuf.ResponseConverter

@InterfaceAudience.Private
public final class ResponseConverter
extends Object

Helper utility to build protocol buffer responses, or retrieve data from protocol buffer responses.

Method Summary

Modifier and Type	Method and Description
static ClientProtos.ResultOrException.Builder	buildActionResult(ClientProtos.Result r) Wrap a throwable to an action result.
static ClientProtos.ResultOrException.Builder	buildActionResult(Throwable t) Wrap a throwable to an action result.
static AdminProtos.ClearRegionBlockCacheResponse	buildClearRegionBlockCacheResponse(HBaseProtos.CacheEvictionStats cacheEvictionStats) Creates a protocol buffer ClearRegionBlockCacheResponse
static MasterProtos.EnableCatalogJanitorResponse	buildEnableCatalogJanitorResponse(boolean prevValue) Creates a response for the catalog scan request
static HBaseProtos.NameBytesPair	buildException(Throwable t)
static RegionServerStatusProtos.GetLastFlushedSequenceIdResponse	buildGetLastFlushedSequenceIdResponse(ClusterStatusProtos.RegionStoreSequenceIds ids) Creates a response for the last flushed sequence Id request
static AdminProtos.GetOnlineRegionResponse	buildGetOnlineRegionResponse(List<RegionInfo> regions) A utility to build a GetOnlineRegionResponse.
static AdminProtos.GetServerInfoResponse	buildGetServerInfoResponse(ServerName serverName, int webuiPort) A utility to build a GetServerInfoResponse.
static MasterProtos.RunCatalogScanResponse	buildRunCatalogScanResponse(int numCleaned) Creates a response for the catalog scan request
static MasterProtos.RunCleanerChoreResponse	buildRunCleanerChoreResponse(boolean ran) Creates a response for the cleaner chore request
static IOException	getControllerException(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller) Retreivies exception stored during RPC invocation.
static List<RegionInfo>	getRegionInfos(AdminProtos.GetOnlineRegionResponse proto) Get the list of region info from a GetOnlineRegionResponse
static SingleResponse	getResult(ClientProtos.MutateRequest request, ClientProtos.MutateResponse response, CellScanner cells)
static Result[]	getResults(CellScanner cellScanner, ClientProtos.ScanResponse response) Create Results from the cells using the cells meta data.
static MultiResponse	getResults(ClientProtos.MultiRequest request, ClientProtos.MultiResponse response, CellScanner cells) Get the results from a protocol buffer MultiResponse
static MultiResponse	getResults(ClientProtos.MultiRequest request, Map<Integer,Integer> rowMutationsIndexMap, ClientProtos.MultiResponse response, CellScanner cells) Get the results from a protocol buffer MultiResponse
static Map<String,Long>	getScanMetrics(ClientProtos.ScanResponse response)
static boolean	isClosed(AdminProtos.CloseRegionResponse proto) Check if the region is closed from a CloseRegionResponse
static void	setControllerException(com.google.protobuf.RpcController controller, IOException ioe) Stores an exception encountered during RPC invocation so it can be passed back through to the client.

Methods inherited from class java.lang.Object

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

Method Detail

getResult

public static SingleResponse getResult(ClientProtos.MutateRequest request,
                                       ClientProtos.MutateResponse response,
                                       CellScanner cells)
                                throws IOException

Throws:

IOException

getResults

public static MultiResponse getResults(ClientProtos.MultiRequest request,
                                       ClientProtos.MultiResponse response,
                                       CellScanner cells)
                                throws IOException

Get the results from a protocol buffer MultiResponse

Parameters:

request - the original protocol buffer MultiRequest

response - the protocol buffer MultiResponse to convert

cells - Cells to go with the passed in proto. Can be null.

Returns:

the results that were in the MultiResponse (a Result or an Exception).

Throws:

IOException

getResults

public static MultiResponse getResults(ClientProtos.MultiRequest request,
                                       Map<Integer,Integer> rowMutationsIndexMap,
                                       ClientProtos.MultiResponse response,
                                       CellScanner cells)
                                throws IOException

Get the results from a protocol buffer MultiResponse

Parameters:

request - the original protocol buffer MultiRequest

rowMutationsIndexMap - Used to support RowMutations in batch

response - the protocol buffer MultiResponse to convert

cells - Cells to go with the passed in proto. Can be null.

Returns:

the results that were in the MultiResponse (a Result or an Exception).

Throws:

IOException

buildActionResult

public static ClientProtos.ResultOrException.Builder buildActionResult(Throwable t)

Wrap a throwable to an action result.

Parameters:

t -

Returns:

an action result builder

buildActionResult

public static ClientProtos.ResultOrException.Builder buildActionResult(ClientProtos.Result r)

Wrap a throwable to an action result.

Parameters:

r -

Returns:

an action result builder

buildException

public static HBaseProtos.NameBytesPair buildException(Throwable t)

Parameters:

t -

Returns:

NameValuePair of the exception name to stringified version os exception.

getRegionInfos

public static List<RegionInfo> getRegionInfos(AdminProtos.GetOnlineRegionResponse proto)

Get the list of region info from a GetOnlineRegionResponse

Parameters:

proto - the GetOnlineRegionResponse

Returns:

the list of region info

isClosed

public static boolean isClosed(AdminProtos.CloseRegionResponse proto)

Check if the region is closed from a CloseRegionResponse

Parameters:

proto - the CloseRegionResponse

Returns:

the region close state

buildGetServerInfoResponse

public static AdminProtos.GetServerInfoResponse buildGetServerInfoResponse(ServerName serverName,
                                                                           int webuiPort)

A utility to build a GetServerInfoResponse.

Parameters:

serverName -

webuiPort -

Returns:

the response

buildGetOnlineRegionResponse

public static AdminProtos.GetOnlineRegionResponse buildGetOnlineRegionResponse(List<RegionInfo> regions)

A utility to build a GetOnlineRegionResponse.

Parameters:

regions -

Returns:

the response

buildRunCatalogScanResponse

public static MasterProtos.RunCatalogScanResponse buildRunCatalogScanResponse(int numCleaned)

Creates a response for the catalog scan request

Returns:

A RunCatalogScanResponse

buildEnableCatalogJanitorResponse

public static MasterProtos.EnableCatalogJanitorResponse buildEnableCatalogJanitorResponse(boolean prevValue)

Creates a response for the catalog scan request

Returns:

A EnableCatalogJanitorResponse

buildRunCleanerChoreResponse

public static MasterProtos.RunCleanerChoreResponse buildRunCleanerChoreResponse(boolean ran)

Creates a response for the cleaner chore request

Returns:

A RunCleanerChoreResponse

buildGetLastFlushedSequenceIdResponse

public static RegionServerStatusProtos.GetLastFlushedSequenceIdResponse buildGetLastFlushedSequenceIdResponse(ClusterStatusProtos.RegionStoreSequenceIds ids)

Creates a response for the last flushed sequence Id request

Returns:

A GetLastFlushedSequenceIdResponse

setControllerException

public static void setControllerException(com.google.protobuf.RpcController controller,
                                          IOException ioe)

Stores an exception encountered during RPC invocation so it can be passed back through to the client.

Parameters:

controller - the controller instance provided by the client when calling the service

ioe - the exception encountered

getControllerException

@Nullable
public static IOException getControllerException(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller)
                                                    throws IOException

Retreivies exception stored during RPC invocation.

Parameters:

controller - the controller instance provided by the client when calling the service

Returns:

exception if any, or null; Will return DoNotRetryIOException for string represented failure causes in controller.

Throws:

IOException

getResults

public static Result[] getResults(CellScanner cellScanner,
                                  ClientProtos.ScanResponse response)
                           throws IOException

Create Results from the cells using the cells meta data.

Parameters:

cellScanner -

response -

Returns:

results

Throws:

IOException

getScanMetrics

public static Map<String,Long> getScanMetrics(ClientProtos.ScanResponse response)

buildClearRegionBlockCacheResponse

public static AdminProtos.ClearRegionBlockCacheResponse buildClearRegionBlockCacheResponse(HBaseProtos.CacheEvictionStats cacheEvictionStats)

Creates a protocol buffer ClearRegionBlockCacheResponse

Returns:

a ClearRegionBlockCacheResponse