org.apache.hadoop.hbase.protobuf
Class ResponseConverter

java.lang.Object
  org.apache.hadoop.hbase.protobuf.ResponseConverter

@InterfaceAudience.Private
public final class ResponseConverter
extends Object

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

Field Summary

static org.apache.commons.logging.Log

LOG

Method Summary

static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException.Builder	buildActionResult(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Result r) Wrap a throwable to an action result.
static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException.Builder	buildActionResult(Throwable t) Wrap a throwable to an action result.
static org.apache.hadoop.hbase.protobuf.generated.MasterProtos.EnableCatalogJanitorResponse	buildEnableCatalogJanitorResponse(boolean prevValue) Creates a response for the catalog scan request
static org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.NameBytesPair	buildException(Throwable t)
static org.apache.hadoop.hbase.protobuf.generated.RegionServerStatusProtos.GetLastFlushedSequenceIdResponse	buildGetLastFlushedSequenceIdResponse(long seqId) Creates a response for the last flushed sequence Id request
static org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetOnlineRegionResponse	buildGetOnlineRegionResponse(List<HRegionInfo> regions) A utility to build a GetOnlineRegionResponse.
static org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetServerInfoResponse	buildGetServerInfoResponse(ServerName serverName, int webuiPort) A utility to build a GetServerInfoResponse.
static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.GetUserPermissionsResponse	buildGetUserPermissionsResponse(List<UserPermission> permissions) Converts the permissions list into a protocol buffer GetUserPermissionsResponse
static org.apache.hadoop.hbase.protobuf.generated.MasterProtos.RunCatalogScanResponse	buildRunCatalogScanResponse(int numCleaned) Creates a response for the catalog scan request
static IOException	getControllerException(com.google.protobuf.RpcController controller) Retreivies exception stored during RPC invocation.
static List<HRegionInfo>	getRegionInfos(org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetOnlineRegionResponse proto) Get the list of region info from a GetOnlineRegionResponse
static RegionOpeningState	getRegionOpeningState(org.apache.hadoop.hbase.protobuf.generated.AdminProtos.OpenRegionResponse proto) Get the region opening state from a OpenRegionResponse
static List<RegionOpeningState>	getRegionOpeningStateList(org.apache.hadoop.hbase.protobuf.generated.AdminProtos.OpenRegionResponse proto) Get a list of region opening state from a OpenRegionResponse
static byte[][]	getRegions(org.apache.hadoop.hbase.protobuf.generated.AdminProtos.RollWALWriterResponse proto) Get the list of regions to flush from a RollLogWriterResponse
static Result[]	getResults(CellScanner cellScanner, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanResponse response) Create Results from the cells using the cells meta data.
static MultiResponse	getResults(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MultiRequest request, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MultiResponse response, CellScanner cells) Get the results from a protocol buffer MultiResponse
static boolean	isClosed(org.apache.hadoop.hbase.protobuf.generated.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

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

Method Detail

getResults

public static MultiResponse getResults(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MultiRequest request,
                                       org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MultiResponse response,
                                       CellScanner cells)
                                throws IOException

Get the results from a protocol buffer MultiResponse

Parameters:

request - 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 org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException.Builder buildActionResult(Throwable t)

Wrap a throwable to an action result.

Parameters:

t -

Returns:

an action result builder

buildActionResult

public static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ResultOrException.Builder buildActionResult(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Result r)

Wrap a throwable to an action result.

Parameters:

r -

Returns:

an action result builder

buildException

public static org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.NameBytesPair buildException(Throwable t)

Parameters:

t -

Returns:

NameValuePair of the exception name to stringified version os exception.

buildGetUserPermissionsResponse

public static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.GetUserPermissionsResponse buildGetUserPermissionsResponse(List<UserPermission> permissions)

Converts the permissions list into a protocol buffer GetUserPermissionsResponse

getRegions

public static byte[][] getRegions(org.apache.hadoop.hbase.protobuf.generated.AdminProtos.RollWALWriterResponse proto)

Get the list of regions to flush from a RollLogWriterResponse

Parameters:

proto - the RollLogWriterResponse

Returns:

the the list of regions to flush

getRegionInfos

public static List<HRegionInfo> getRegionInfos(org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetOnlineRegionResponse proto)

Get the list of region info from a GetOnlineRegionResponse

Parameters:

proto - the GetOnlineRegionResponse

Returns:

the list of region info

getRegionOpeningState

public static RegionOpeningState getRegionOpeningState(org.apache.hadoop.hbase.protobuf.generated.AdminProtos.OpenRegionResponse proto)

Get the region opening state from a OpenRegionResponse

Parameters:

proto - the OpenRegionResponse

Returns:

the region opening state

getRegionOpeningStateList

public static List<RegionOpeningState> getRegionOpeningStateList(org.apache.hadoop.hbase.protobuf.generated.AdminProtos.OpenRegionResponse proto)

Get a list of region opening state from a OpenRegionResponse

Parameters:

proto - the OpenRegionResponse

Returns:

the list of region opening state

isClosed

public static boolean isClosed(org.apache.hadoop.hbase.protobuf.generated.AdminProtos.CloseRegionResponse proto)

Check if the region is closed from a CloseRegionResponse

Parameters:

proto - the CloseRegionResponse

Returns:

the region close state

buildGetServerInfoResponse

public static org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetServerInfoResponse buildGetServerInfoResponse(ServerName serverName,
                                                                                                                      int webuiPort)

A utility to build a GetServerInfoResponse.

Parameters:

serverName -

webuiPort -

Returns:

the response

buildGetOnlineRegionResponse

public static org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetOnlineRegionResponse buildGetOnlineRegionResponse(List<HRegionInfo> regions)

A utility to build a GetOnlineRegionResponse.

Parameters:

regions -

Returns:

the response

buildRunCatalogScanResponse

public static org.apache.hadoop.hbase.protobuf.generated.MasterProtos.RunCatalogScanResponse buildRunCatalogScanResponse(int numCleaned)

Creates a response for the catalog scan request

Returns:

A RunCatalogScanResponse

buildEnableCatalogJanitorResponse

public static org.apache.hadoop.hbase.protobuf.generated.MasterProtos.EnableCatalogJanitorResponse buildEnableCatalogJanitorResponse(boolean prevValue)

Creates a response for the catalog scan request

Returns:

A EnableCatalogJanitorResponse

buildGetLastFlushedSequenceIdResponse

public static org.apache.hadoop.hbase.protobuf.generated.RegionServerStatusProtos.GetLastFlushedSequenceIdResponse buildGetLastFlushedSequenceIdResponse(long seqId)

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(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,
                                  org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanResponse response)
                           throws IOException

Create Results from the cells using the cells meta data.

Parameters:

cellScanner -

response -

Returns:

results

Throws:

IOException