org.apache.hadoop.hbase.rest

Interface ProtobufMessageHandler

All Known Implementing Classes:

CellModel, CellSetModel, NamespacesInstanceModel, NamespacesModel, RowModel, ScannerModel, StorageClusterStatusModel, TableInfoModel, TableListModel, TableSchemaModel, VersionModel

@InterfaceAudience.Private
public interface ProtobufMessageHandler

Common interface for models capable of supporting protobuf marshalling and unmarshalling. Hooks up to the ProtobufMessageBodyConsumer and ProtobufMessageBodyProducer adapters.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE

Method Summary

Modifier and Type	Method and Description
default byte[]	createProtobufOutput() Returns the protobuf represention of the model in a byte array.
default ProtobufMessageHandler	getObjectFromMessage(byte[] message) Initialize the model from a protobuf representation.
ProtobufMessageHandler	getObjectFromMessage(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream cis)
default ProtobufMessageHandler	getObjectFromMessage(InputStream is) Initialize the model from a protobuf representation.
org.apache.hbase.thirdparty.com.google.protobuf.Message	messageFromObject() Convert to model to a protobuf Message object
default void	writeProtobufOutput(OutputStream os) Writes the protobuf represention of the model to os

Field Detail

BUFFER_SIZE

static final int BUFFER_SIZE

See Also:

Constant Field Values

Method Detail

writeProtobufOutput

default void writeProtobufOutput(OutputStream os)
                          throws IOException

Writes the protobuf represention of the model to os

Throws:

IOException

createProtobufOutput

default byte[] createProtobufOutput()

Returns the protobuf represention of the model in a byte array. Use writeProtobufOutput(OutputStream) for better performance

Returns:

the protobuf encoded object in a byte array

messageFromObject

org.apache.hbase.thirdparty.com.google.protobuf.Message messageFromObject()

Convert to model to a protobuf Message object

Returns:

the protobuf Message object

getObjectFromMessage

default ProtobufMessageHandler getObjectFromMessage(byte[] message)
                                             throws IOException

Initialize the model from a protobuf representation. Use getObjectFromMessage(InputStream) for better performance

Parameters:

message - the raw bytes of the protobuf message

Returns:

reference to self for convenience

Throws:

IOException

getObjectFromMessage

default ProtobufMessageHandler getObjectFromMessage(InputStream is)
                                             throws IOException

Initialize the model from a protobuf representation.

Parameters:

is - InputStream providing the protobuf message

Returns:

reference to self for convenience

Throws:

IOException

getObjectFromMessage

ProtobufMessageHandler getObjectFromMessage(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream cis)
                                     throws IOException

Throws:

IOException