org.apache.hadoop.hbase.protobuf

Class ProtobufUtil

java.lang.Object

org.apache.hadoop.hbase.protobuf.ProtobufUtil

@InterfaceAudience.Private
public final class ProtobufUtil
extends Object

Protobufs utility. NOTE: This class OVERLAPS ProtobufUtil in the subpackage 'shaded'. The latter is used internally and has more methods. This Class is for Coprocessor Endpoints only though they should not be using this private class. It should not be depended upon. Most methods here are COPIED from the shaded ProtobufUtils with only difference being they refer to non-shaded protobufs.

See Also:

ProtobufUtil

Method Summary

Modifier and Type	Method and Description
static AdminProtos.GetServerInfoRequest	buildGetServerInfoRequest() Create a new GetServerInfoRequest
static HBaseProtos.RegionSpecifier	buildRegionSpecifier(HBaseProtos.RegionSpecifier.RegionSpecifierType type, byte[] value) Convert a byte array to a protocol buffer RegionSpecifier
static HBaseProtos.SnapshotDescription.Type	createProtosSnapShotDescType(SnapshotType type) Creates HBaseProtos.SnapshotDescription.Type from SnapshotType
static void	expectPBMagicPrefix(byte[] bytes)
static KeyValue.Type	fromDeleteType(ClientProtos.MutationProto.DeleteType type) Convert a protocol buffer DeleteType to delete KeyValue type.
static IOException	getRemoteException(com.google.protobuf.ServiceException se) Return the IOException thrown by the remote server wrapped in ServiceException as cause.
static AdminProtos.ServerInfo	getServerInfo(com.google.protobuf.RpcController controller, AdminProtos.AdminService.BlockingInterface admin) A helper to get the info of a region server using admin protocol.
static IOException	getServiceException(org.apache.hbase.thirdparty.com.google.protobuf.ServiceException e) Return the Exception thrown by the remote server wrapped in ServiceException as cause.
static IOException	handleRemoteException(Exception e) Like getRemoteException(ServiceException) but more generic, able to handle more than just ServiceException.
static boolean	isPBMagicPrefix(byte[] bytes)
static boolean	isPBMagicPrefix(byte[] bytes, int offset, int len)
static int	lengthOfPBMagic()
static void	mergeFrom(com.google.protobuf.Message.Builder builder, byte[] b) This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers when working with byte arrays
static void	mergeFrom(com.google.protobuf.Message.Builder builder, byte[] b, int offset, int length) This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers when working with byte arrays
static <T extends com.google.protobuf.Service> T	newServiceStub(Class<T> service, com.google.protobuf.RpcChannel channel)
static byte[]	prependPBMagic(byte[] bytes) Prepend the passed bytes with four bytes of magic, ProtobufMagic.PB_MAGIC, to flag what follows as a protobuf in hbase.
static Append	toAppend(ClientProtos.MutationProto proto, CellScanner cellScanner) Convert a protocol buffer Mutate to an Append
static CellProtos.Cell	toCell(Cell kv)
static Cell	toCell(ExtendedCellBuilder cellBuilder, CellProtos.Cell cell)
static ComparatorProtos.Comparator	toComparator(ByteArrayComparable comparator) Convert a ByteArrayComparable to a protocol buffer Comparator
static ByteArrayComparable	toComparator(ComparatorProtos.Comparator proto) Convert a protocol buffer Comparator to a ByteArrayComparable
static Consistency	toConsistency(ClientProtos.Consistency consistency)
static ClientProtos.Consistency	toConsistency(Consistency consistency)
static Delete	toDelete(ClientProtos.MutationProto proto) Convert a protocol buffer Mutate to a Delete
static Delete	toDelete(ClientProtos.MutationProto proto, CellScanner cellScanner) Convert a protocol buffer Mutate to a Delete
static ClientProtos.MutationProto.DeleteType	toDeleteType(KeyValue.Type type) Convert a delete KeyValue type to protocol buffer DeleteType.
static Durability	toDurability(ClientProtos.MutationProto.Durability proto) Convert a protobuf Durability into a client Durability
static ClientProtos.MutationProto.Durability	toDurability(Durability d) Convert a client Durability into a protbuf Durability
static Throwable	toException(HBaseProtos.NameBytesPair parameter) Convert a stringified protocol buffer exception Parameter to a Java Exception
static FilterProtos.Filter	toFilter(Filter filter) Convert a client Filter to a protocol buffer Filter
static Filter	toFilter(FilterProtos.Filter proto) Convert a protocol buffer Filter to a client Filter
static Get	toGet(ClientProtos.Get proto) Convert a protocol buffer Get to a client Get
static Get	toGet(ClientProtos.MutationProto proto, CellScanner cellScanner) Convert a protocol buffer Mutate to a Get.
static ClientProtos.Get	toGet(Get get) Create a protocol buffer Get based on a client Get.
static RSGroupInfo	toGroupInfo(RSGroupProtos.RSGroupInfo proto)
static Increment	toIncrement(ClientProtos.MutationProto proto, CellScanner cellScanner) Convert a protocol buffer Mutate to an Increment
static void	toIOException(com.google.protobuf.ServiceException se) Unwraps an exception from a protobuf service into the underlying (expected) IOException.
static ClientProtos.MutationProto	toMutation(ClientProtos.MutationProto.MutationType type, Mutation mutation)
static ClientProtos.MutationProto	toMutation(ClientProtos.MutationProto.MutationType type, Mutation mutation, ClientProtos.MutationProto.Builder builder)
static ClientProtos.MutationProto	toMutation(ClientProtos.MutationProto.MutationType type, Mutation mutation, ClientProtos.MutationProto.Builder builder, long nonce)
static ClientProtos.MutationProto	toMutation(ClientProtos.MutationProto.MutationType type, Mutation mutation, long nonce) Create a protocol buffer Mutate based on a client Mutation
static Mutation	toMutation(ClientProtos.MutationProto proto) Convert a MutateRequest to Mutation
static ClientProtos.MutationProto	toMutationNoData(ClientProtos.MutationProto.MutationType type, Mutation mutation) Create a protocol buffer MutationProto based on a client Mutation.
static ClientProtos.MutationProto	toMutationNoData(ClientProtos.MutationProto.MutationType type, Mutation mutation, ClientProtos.MutationProto.Builder builder) Create a protocol buffer MutationProto based on a client Mutation.
static ClientProtos.MutationProto	toMutationNoData(ClientProtos.MutationProto.MutationType type, Mutation mutation, ClientProtos.MutationProto.Builder builder, long nonce)
static TableProtos.TableName	toProtoTableName(TableName tableName)
static Put	toPut(ClientProtos.MutationProto proto) Convert a protocol buffer Mutate to a Put.
static Put	toPut(ClientProtos.MutationProto proto, CellScanner cellScanner) Convert a protocol buffer Mutate to a Put.
static Scan.ReadType	toReadType(ClientProtos.Scan.ReadType readType)
static ClientProtos.Scan.ReadType	toReadType(Scan.ReadType readType)
static ClientProtos.Result	toResult(boolean existence, boolean stale) Convert a client Result to a protocol buffer Result
static Result	toResult(ClientProtos.Result proto) Convert a protocol buffer Result to a client Result
static Result	toResult(ClientProtos.Result proto, CellScanner scanner) Convert a protocol buffer Result to a client Result
static ClientProtos.Result	toResult(Result result) Convert a client Result to a protocol buffer Result
static ClientProtos.Result	toResultNoData(Result result) Convert a client Result to a protocol buffer Result.
static Scan	toScan(ClientProtos.Scan proto) Convert a protocol buffer Scan to a client Scan
static ClientProtos.Scan	toScan(Scan scan) Convert a client Scan to a protocol buffer Scan
static ScanMetrics	toScanMetrics(byte[] bytes)
static ServerName	toServerName(byte[] data) Get a ServerName from the passed in data bytes.
static ServerName	toServerName(HBaseProtos.ServerName proto) Convert a protocol buffer ServerName to a ServerName
static HBaseProtos.ServerName	toServerName(ServerName serverName) Convert a ServerName to a protocol buffer ServerName
static TableName	toTableName(TableProtos.TableName tableNamePB)
static HBaseProtos.TimeRange	toTimeRange(TimeRange timeRange)

Methods inherited from class java.lang.Object

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

Method Detail

prependPBMagic

public static byte[] prependPBMagic(byte[] bytes)

Prepend the passed bytes with four bytes of magic, ProtobufMagic.PB_MAGIC, to flag what follows as a protobuf in hbase. Prepend these bytes to all content written to znodes, etc.

Parameters:

bytes - Bytes to decorate

Returns:

The passed bytes with magic prepended (Creates a new byte array that is bytes.length plus ProtobufMagic.PB_MAGIC.length.

isPBMagicPrefix

public static boolean isPBMagicPrefix(byte[] bytes)

Parameters:

bytes - Bytes to check.

Returns:

True if passed bytes has ProtobufMagic.PB_MAGIC for a prefix.

isPBMagicPrefix

public static boolean isPBMagicPrefix(byte[] bytes,
                                      int offset,
                                      int len)

Parameters:

bytes - Bytes to check.

offset - offset to start at

len - length to use

Returns:

True if passed bytes has ProtobufMagic.PB_MAGIC for a prefix.

expectPBMagicPrefix

public static void expectPBMagicPrefix(byte[] bytes)
                                throws DeserializationException

Parameters:

bytes - bytes to check

Throws:

DeserializationException - if we are missing the pb magic prefix

lengthOfPBMagic

public static int lengthOfPBMagic()

Returns:

Length of ProtobufMagic.lengthOfPBMagic()

getRemoteException

public static IOException getRemoteException(com.google.protobuf.ServiceException se)

Return the IOException thrown by the remote server wrapped in ServiceException as cause.

Parameters:

se - ServiceException that wraps IO exception thrown by the server

Returns:

Exception wrapped in ServiceException or a new IOException that wraps the unexpected ServiceException.

getServiceException

public static IOException getServiceException(org.apache.hbase.thirdparty.com.google.protobuf.ServiceException e)

Return the Exception thrown by the remote server wrapped in ServiceException as cause. RemoteException are left untouched.

Parameters:

e - ServiceException that wraps IO exception thrown by the server

Returns:

Exception wrapped in ServiceException.

handleRemoteException

public static IOException handleRemoteException(Exception e)

Like getRemoteException(ServiceException) but more generic, able to handle more than just ServiceException. Prefer this method to getRemoteException(ServiceException) because trying to contain direct protobuf references.

Parameters:

e -

toServerName

public static HBaseProtos.ServerName toServerName(ServerName serverName)

Convert a ServerName to a protocol buffer ServerName

Parameters:

serverName - the ServerName to convert

Returns:

the converted protocol buffer ServerName

See Also:

toServerName(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.ServerName)

toServerName

public static ServerName toServerName(HBaseProtos.ServerName proto)

Convert a protocol buffer ServerName to a ServerName

Parameters:

proto - the protocol buffer ServerName to convert

Returns:

the converted ServerName

toDurability

public static Durability toDurability(ClientProtos.MutationProto.Durability proto)

Convert a protobuf Durability into a client Durability

toDurability

public static ClientProtos.MutationProto.Durability toDurability(Durability d)

Convert a client Durability into a protbuf Durability

toGet

public static Get toGet(ClientProtos.Get proto)
                 throws IOException

Convert a protocol buffer Get to a client Get

Parameters:

proto - the protocol buffer Get to convert

Returns:

the converted client Get

Throws:

IOException

toConsistency

public static Consistency toConsistency(ClientProtos.Consistency consistency)

toConsistency

public static ClientProtos.Consistency toConsistency(Consistency consistency)

toPut

public static Put toPut(ClientProtos.MutationProto proto)
                 throws IOException

Convert a protocol buffer Mutate to a Put.

Parameters:

proto - The protocol buffer MutationProto to convert

Returns:

A client Put.

Throws:

IOException

toPut

public static Put toPut(ClientProtos.MutationProto proto,
                        CellScanner cellScanner)
                 throws IOException

Convert a protocol buffer Mutate to a Put.

Parameters:

proto - The protocol buffer MutationProto to convert

cellScanner - If non-null, the Cell data that goes with this proto.

Returns:

A client Put.

Throws:

IOException

toDelete

public static Delete toDelete(ClientProtos.MutationProto proto)
                       throws IOException

Convert a protocol buffer Mutate to a Delete

Parameters:

proto - the protocol buffer Mutate to convert

Returns:

the converted client Delete

Throws:

IOException

toDelete

public static Delete toDelete(ClientProtos.MutationProto proto,
                              CellScanner cellScanner)
                       throws IOException

Convert a protocol buffer Mutate to a Delete

Parameters:

proto - the protocol buffer Mutate to convert

cellScanner - if non-null, the data that goes with this delete.

Returns:

the converted client Delete

Throws:

IOException

toAppend

public static Append toAppend(ClientProtos.MutationProto proto,
                              CellScanner cellScanner)
                       throws IOException

Convert a protocol buffer Mutate to an Append

Parameters:

cellScanner -

proto - the protocol buffer Mutate to convert

Returns:

the converted client Append

Throws:

IOException

toIncrement

public static Increment toIncrement(ClientProtos.MutationProto proto,
                                    CellScanner cellScanner)
                             throws IOException

Convert a protocol buffer Mutate to an Increment

Parameters:

proto - the protocol buffer Mutate to convert

Returns:

the converted client Increment

Throws:

IOException

toMutation

public static Mutation toMutation(ClientProtos.MutationProto proto)
                           throws IOException

Convert a MutateRequest to Mutation

Parameters:

proto - the protocol buffer Mutate to convert

Returns:

the converted Mutation

Throws:

IOException

toGet

public static Get toGet(ClientProtos.MutationProto proto,
                        CellScanner cellScanner)
                 throws IOException

Convert a protocol buffer Mutate to a Get.

Parameters:

proto - the protocol buffer Mutate to convert.

cellScanner -

Returns:

the converted client get.

Throws:

IOException

toReadType

public static ClientProtos.Scan.ReadType toReadType(Scan.ReadType readType)

toReadType

public static Scan.ReadType toReadType(ClientProtos.Scan.ReadType readType)

toScan

public static ClientProtos.Scan toScan(Scan scan)
                                throws IOException

Convert a client Scan to a protocol buffer Scan

Parameters:

scan - the client Scan to convert

Returns:

the converted protocol buffer Scan

Throws:

IOException

toScan

public static Scan toScan(ClientProtos.Scan proto)
                   throws IOException

Convert a protocol buffer Scan to a client Scan

Parameters:

proto - the protocol buffer Scan to convert

Returns:

the converted client Scan

Throws:

IOException

toGet

public static ClientProtos.Get toGet(Get get)
                              throws IOException

Create a protocol buffer Get based on a client Get.

Parameters:

get - the client Get

Returns:

a protocol buffer Get

Throws:

IOException

toMutation

public static ClientProtos.MutationProto toMutation(ClientProtos.MutationProto.MutationType type,
                                                    Mutation mutation)
                                             throws IOException

Throws:

IOException

toMutation

public static ClientProtos.MutationProto toMutation(ClientProtos.MutationProto.MutationType type,
                                                    Mutation mutation,
                                                    long nonce)
                                             throws IOException

Create a protocol buffer Mutate based on a client Mutation

Parameters:

type -

mutation -

Returns:

a protobuf'd Mutation

Throws:

IOException

toMutation

public static ClientProtos.MutationProto toMutation(ClientProtos.MutationProto.MutationType type,
                                                    Mutation mutation,
                                                    ClientProtos.MutationProto.Builder builder)
                                             throws IOException

Throws:

IOException

toMutation

public static ClientProtos.MutationProto toMutation(ClientProtos.MutationProto.MutationType type,
                                                    Mutation mutation,
                                                    ClientProtos.MutationProto.Builder builder,
                                                    long nonce)
                                             throws IOException

Throws:

IOException

toMutationNoData

public static ClientProtos.MutationProto toMutationNoData(ClientProtos.MutationProto.MutationType type,
                                                          Mutation mutation,
                                                          ClientProtos.MutationProto.Builder builder)
                                                   throws IOException

Create a protocol buffer MutationProto based on a client Mutation. Does NOT include data. Understanding is that the Cell will be transported other than via protobuf.

Parameters:

type -

mutation -

builder -

Returns:

a protobuf'd Mutation

Throws:

IOException

toMutationNoData

public static ClientProtos.MutationProto toMutationNoData(ClientProtos.MutationProto.MutationType type,
                                                          Mutation mutation)
                                                   throws IOException

Create a protocol buffer MutationProto based on a client Mutation. Does NOT include data. Understanding is that the Cell will be transported other than via protobuf.

Parameters:

type -

mutation -

Returns:

a protobuf'd Mutation

Throws:

IOException

toMutationNoData

public static ClientProtos.MutationProto toMutationNoData(ClientProtos.MutationProto.MutationType type,
                                                          Mutation mutation,
                                                          ClientProtos.MutationProto.Builder builder,
                                                          long nonce)
                                                   throws IOException

Throws:

IOException

toResult

public static ClientProtos.Result toResult(Result result)

Convert a client Result to a protocol buffer Result

Parameters:

result - the client Result to convert

Returns:

the converted protocol buffer Result

toResult

public static ClientProtos.Result toResult(boolean existence,
                                           boolean stale)

Convert a client Result to a protocol buffer Result

Parameters:

existence - the client existence to send

Returns:

the converted protocol buffer Result

toResultNoData

public static ClientProtos.Result toResultNoData(Result result)

Convert a client Result to a protocol buffer Result. The pb Result does not include the Cell data. That is for transport otherwise.

Parameters:

result - the client Result to convert

Returns:

the converted protocol buffer Result

toResult

public static Result toResult(ClientProtos.Result proto)

Convert a protocol buffer Result to a client Result

Parameters:

proto - the protocol buffer Result to convert

Returns:

the converted client Result

toResult

public static Result toResult(ClientProtos.Result proto,
                              CellScanner scanner)
                       throws IOException

Convert a protocol buffer Result to a client Result

Parameters:

proto - the protocol buffer Result to convert

scanner - Optional cell scanner.

Returns:

the converted client Result

Throws:

IOException

toComparator

public static ComparatorProtos.Comparator toComparator(ByteArrayComparable comparator)

Convert a ByteArrayComparable to a protocol buffer Comparator

Parameters:

comparator - the ByteArrayComparable to convert

Returns:

the converted protocol buffer Comparator

toComparator

public static ByteArrayComparable toComparator(ComparatorProtos.Comparator proto)
                                        throws IOException

Convert a protocol buffer Comparator to a ByteArrayComparable

Parameters:

proto - the protocol buffer Comparator to convert

Returns:

the converted ByteArrayComparable

Throws:

IOException

toFilter

public static Filter toFilter(FilterProtos.Filter proto)
                       throws IOException

Convert a protocol buffer Filter to a client Filter

Parameters:

proto - the protocol buffer Filter to convert

Returns:

the converted Filter

Throws:

IOException

toFilter

public static FilterProtos.Filter toFilter(Filter filter)
                                    throws IOException

Convert a client Filter to a protocol buffer Filter

Parameters:

filter - the Filter to convert

Returns:

the converted protocol buffer Filter

Throws:

IOException

toDeleteType

public static ClientProtos.MutationProto.DeleteType toDeleteType(KeyValue.Type type)
                                                          throws IOException

Convert a delete KeyValue type to protocol buffer DeleteType.

Parameters:

type -

Returns:

protocol buffer DeleteType

Throws:

IOException

fromDeleteType

public static KeyValue.Type fromDeleteType(ClientProtos.MutationProto.DeleteType type)
                                    throws IOException

Convert a protocol buffer DeleteType to delete KeyValue type.

Parameters:

type - The DeleteType

Returns:

The type.

Throws:

IOException

toException

public static Throwable toException(HBaseProtos.NameBytesPair parameter)
                             throws IOException

Convert a stringified protocol buffer exception Parameter to a Java Exception

Parameters:

parameter - the protocol buffer Parameter to convert

Returns:

the converted Exception

Throws:

IOException - if failed to deserialize the parameter

newServiceStub

public static <T extends com.google.protobuf.Service> T newServiceStub(Class<T> service,
                                                                       com.google.protobuf.RpcChannel channel)
                                                                throws Exception

Throws:

Exception

getServerInfo

public static AdminProtos.ServerInfo getServerInfo(com.google.protobuf.RpcController controller,
                                                   AdminProtos.AdminService.BlockingInterface admin)
                                            throws IOException

A helper to get the info of a region server using admin protocol.

Returns:

the server name

Throws:

IOException

buildGetServerInfoRequest

public static AdminProtos.GetServerInfoRequest buildGetServerInfoRequest()

Create a new GetServerInfoRequest

Returns:

a GetServerInfoRequest

toScanMetrics

public static ScanMetrics toScanMetrics(byte[] bytes)

toIOException

public static void toIOException(com.google.protobuf.ServiceException se)
                          throws IOException

Unwraps an exception from a protobuf service into the underlying (expected) IOException. This method will always throw an exception.

Parameters:

se - the ServiceException instance to convert into an IOException

Throws:

IOException

toCell

public static CellProtos.Cell toCell(Cell kv)

toCell

public static Cell toCell(ExtendedCellBuilder cellBuilder,
                          CellProtos.Cell cell)

toTableName

public static TableName toTableName(TableProtos.TableName tableNamePB)

toProtoTableName

public static TableProtos.TableName toProtoTableName(TableName tableName)

mergeFrom

public static void mergeFrom(com.google.protobuf.Message.Builder builder,
                             byte[] b)
                      throws IOException

This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers when working with byte arrays

Parameters:

builder - current message builder

b - byte array

Throws:

IOException

mergeFrom

public static void mergeFrom(com.google.protobuf.Message.Builder builder,
                             byte[] b,
                             int offset,
                             int length)
                      throws IOException

This version of protobuf's mergeFrom avoids the hard-coded 64MB limit for decoding buffers when working with byte arrays

Parameters:

builder - current message builder

b - byte array

offset -

length -

Throws:

IOException

createProtosSnapShotDescType

public static HBaseProtos.SnapshotDescription.Type createProtosSnapShotDescType(SnapshotType type)

Creates HBaseProtos.SnapshotDescription.Type from SnapshotType

Parameters:

type - the SnapshotDescription type

Returns:

the protobuf SnapshotDescription type

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

toServerName

public static ServerName toServerName(byte[] data)
                               throws DeserializationException

Get a ServerName from the passed in data bytes.

Parameters:

data - Data with a serialize server name in it; can handle the old style servername where servername was host and port. Works too with data that begins w/ the pb 'PBUF' magic and that is then followed by a protobuf that has a serialized ServerName in it.

Returns:

Returns null if data is null else converts passed data to a ServerName instance.

Throws:

DeserializationException

toGroupInfo

public static RSGroupInfo toGroupInfo(RSGroupProtos.RSGroupInfo proto)

toTimeRange

public static HBaseProtos.TimeRange toTimeRange(TimeRange timeRange)